Package org.opencms.workplace.help

Class CmsHelpTemplateBean

java.lang.Object
org.opencms.workplace.CmsWorkplace
org.opencms.workplace.tools.CmsToolDialog
org.opencms.workplace.CmsDialog
org.opencms.workplace.help.CmsHelpTemplateBean
public class CmsHelpTemplateBean extends org.opencms.workplace.CmsDialog
The bean that provides methods to build the HTML for the single online help frames.

Things to know

  • Online help will only work with resources of type xmlpage.
  • Content pages with a property "template-elements" set to a path of a ressource (jsp, page,...) will get the content produced by CmsJspActionElement.getContent(String) appended after their own output. This allows to use jsp's in the online help template.
Since:
6.0.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    DEFAULT_HELPFILE
    File name of the default help file to load.
    static final String
    HELPMAPPINGS_FILENAME
    File name of the help mappings properties file(s).
    static final String
    MODULE_NAME
    The name of the help module.
    static final String
    PARAM_BUILDFRAME
    Request parameter name for the buildframe flag parameter.
    static final String
    PARAM_HELPRESOURCE
    Request parameter name for the helpresource uri.
    static final String
    PARAM_HOMELINK
    Request parameter name for the homelink in head frame.
    static final String
    PARAM_WORKPLACERESOURCE
    Request parameter name for the workplaceresource uri.
    static final String
    PATH_HELP
    VFS path to the help folder, contains a macro for the Locale which has to be resolved.
    static final String
    PROPERTY_VALUE_HELPSTART
    Value of the NavInfo property indicating the start folder of the help.
    static final String
    RFS_HELPMAPPINGS
    Relative RFS path of the help mappings property file(s).
    static final String
    TEMPLATEPATH
    Absolute path to used JSP templates.

    Fields inherited from class org.opencms.workplace.CmsDialog

    ACTION_CANCEL, ACTION_CLOSEPOPUP, ACTION_CLOSEPOPUP_SAVE, ACTION_CONFIRMED, ACTION_CONTINUE, ACTION_DEFAULT, ACTION_LOCKS_CONFIRMED, ACTION_OK, ACTION_REPORT_BEGIN, ACTION_REPORT_END, ACTION_REPORT_UPDATE, ACTION_SET, ACTION_WAIT, ATTRIBUTE_THROWABLE, BUTTON_ADVANCED, BUTTON_BACK, BUTTON_CANCEL, BUTTON_CLOSE, BUTTON_CONTINUE, BUTTON_DETAILS, BUTTON_DISCARD, BUTTON_EDIT, BUTTON_OK, BUTTON_OK_NO_SUBMIT, BUTTON_SET, DIALOG_BACK, DIALOG_CANCEL, DIALOG_CONFIRMED, DIALOG_CONTINUE, DIALOG_INITIAL, DIALOG_LOCKS_CONFIRMED, DIALOG_OK, DIALOG_SET, DIALOG_WAIT, PARAM_ACTION, PARAM_ACTION_VALUE_FOR_CHANGED_INDEX, PARAM_CLOSELINK, PARAM_DIALOGTYPE, PARAM_ERRORSTACK, PARAM_FILE, PARAM_FRAMENAME, PARAM_ISPOPUP, PARAM_LOCK, PARAM_MESSAGE, PARAM_ORIGINALPARAMS, PARAM_PREACTIONDONE, PARAM_REDIRECT, PARAM_RESOURCE, PARAM_TARGET, PARAM_THREAD, PARAM_THREAD_HASNEXT, PARAM_TITLE, REPORT_BEGIN, REPORT_END, REPORT_UPDATE

    Fields inherited from class org.opencms.workplace.tools.CmsToolDialog

    PARAM_ADMIN_PROJECT, PARAM_BASE, PARAM_FORCE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW

    Fields inherited from class org.opencms.workplace.CmsWorkplace

    DEBUG, DEFAULT_DATE_STRING, DEFAULT_LANGUAGE, DEFAULT_LOCALE, DIALOG_PATH_COMMON, FILE_DIALOG_CLOSE, FILE_DIALOG_SCREEN_CONFIRM, FILE_DIALOG_SCREEN_ERROR, FILE_DIALOG_SCREEN_ERRORPAGE, FILE_DIALOG_SCREEN_WAIT, FILE_EXPLORER_FILELIST, FILE_REPORT_OUTPUT, HTML_END, HTML_START, INPUT_DEFAULT, INPUT_NONE, JSP_WORKPLACE_URI, PARAM_DIRECTPUBLISH, PARAM_MODELFILE, PARAM_NEWRESOURCETYPE, PARAM_PUBLISHSIBLINGS, PARAM_RELATEDRESOURCES, PARAM_RESOURCELIST, PARAM_SUBRESOURCES, PARAM_WP_EXPLORER_RESOURCE, PARAM_WP_PROJECT, PARAM_WP_SITE, PARAM_WP_START, PARAM_WP_VIEW, PATH_DIALOGS, PATH_WORKPLACE, REQUEST_ATTRIBUTE_MULTIPART, REQUEST_ATTRIBUTE_RELOADTREE, RES_PATH_FILETYPES, RFS_PATH_RESOURCES, SESSION_WORKPLACE_CLASS, VFS_DIR_DEFAULTBODIES, VFS_DIR_TEMPLATES, VFS_PATH_COMMONS, VFS_PATH_EDITORS, VFS_PATH_GALLERIES, VFS_PATH_LOCALES, VFS_PATH_MODELDIALOG, VFS_PATH_MODULES, VFS_PATH_NEWRESOURCEDIALOG, VFS_PATH_RESOURCES, VFS_PATH_SITES, VFS_PATH_SYSTEM, VFS_PATH_VIEWS, VFS_PATH_WORKPLACE, VIEW_ADMIN, VIEW_DIRECT_EDIT, VIEW_EXPLORER, VIEW_GALLERY, VIEW_LIST, VIEW_WORKPLACE

  • Constructor Summary

    Constructors
    Constructor
    Description
    CmsHelpTemplateBean(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
    Public constructor with JSP variables.
    CmsHelpTemplateBean(org.opencms.jsp.CmsJspActionElement jsp)
    Public constructor with JSP action element.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    buildHtmlHelpEnd()
    Returns the HTML for the end of the page.
    protected String
    buildHtmlHelpNavigation()
    Returns the HTML to build the navigation of the online help folder.
    String
    buildHtmlHelpStart(String cssFile, boolean transitional)
    Returns the HTML for the start of the page.
    static String
    buildOnlineHelpJavaScript(Locale locale)
    Returns the java script method to open the online help window.
    protected void
    checkRole()
     
    String
    displayBody()
    Returns the HTML for the body frame of the online help.
    protected String
    displayFrameset()
    Returns the HTML to build the frameset for the online help popup window.
    String
    displayHead()
    Returns the HTML for the head frame of the online help.
    String
    displayHelp()
    Generates the HTML for the online help frameset or redirects to the help body, depending on the build frameset flag.
    protected void
    getMappedHelpUri()
    Determines the mapped help page for a given workplace resource URI.
    String
    getParamBuildframe()
    Returns the buildframe parameter indicating if the frameset should be generated.
    String
    getParamHelpresource()
    Returns the helpresource parameter value.
    String
    getParamHomelink()
    Returns the homelink parameter value.
    String
    getParamWorkplaceresource()
    Returns the workplaceresource parameter value.
    protected void
    initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
     
    protected boolean
    isBuildFrameset()
    Returns true if the online help frameset has to be generated.
    void
    setParamBuildframe(String buildframe)
    Sets the buildframe parameter indicating if the frameset should be generated.
    void
    setParamHelpresource(String helpresource)
    Sets the helpresource parameter value.
    void
    setParamHomelink(String homelink)
    Sets the homelink parameter value.
    void
    setParamWorkplaceresource(String workplaceresource)
    Sets the workplaceresource parameter value.

    Methods inherited from class org.opencms.workplace.CmsDialog

    actionCloseDialog, appendDelimiter, buildAjaxResultContainer, buildAjaxWaitMessage, buildLockAdditionalOptions, buildLockConfirmationMessageJS, buildLockHeaderBox, checkResourcePermissions, checkResourcePermissions, computeCurrentFolder, dialog, dialogBlock, dialogBlockEnd, dialogBlockStart, dialogButtonRow, dialogButtonRowEnd, dialogButtonRowStart, dialogButtons, dialogButtonsClose, dialogButtonsClose, dialogButtonsCloseDetails, dialogButtonsHtml, dialogButtonsOk, dialogButtonsOk, dialogButtonsOkCancel, dialogButtonsOkCancel, dialogButtonsOkCancelAdvanced, dialogButtonsSetOkCancel, dialogContent, dialogContentEnd, dialogContentStart, dialogEnd, dialogHead, dialogHorizontalSpacer, dialogLockButtons, dialogRow, dialogRowEnd, dialogRowStart, dialogScriptSubmit, dialogSeparator, dialogSpacer, dialogStart, dialogStart, dialogSubheadline, dialogToggleStart, dialogWhiteBox, dialogWhiteBoxEnd, dialogWhiteBoxStart, getAction, getAdministrationBackLink, getCancelAction, getDialogRealUri, getDialogUri, getOnlineHelpUriCustom, getParamAction, getParamCloseLink, getParamDialogtype, getParamFramename, getParamIsPopup, getParamMessage, getParamOriginalParams, getParamPreActionDone, getParamRedirect, getParamResource, getParamTitle, getState, hasCorrectLockstate, hasSiblings, htmlStart, htmlStart, htmlStart, htmlStartStyle, includeErrorpage, initCmsDialog, isPopup, isPreEditor, openLaunchpad, openWorkplaceLink, pageHtml, pageHtml, setAction, setOnlineHelpUriCustom, setParamAction, setParamCloseLink, setParamDialogtype, setParamFramename, setParamIsPopup, setParamMessage, setParamOriginalParams, setParamPreActionDone, setParamRedirect, setParamResource, setParamTitle

    Methods inherited from class org.opencms.workplace.tools.CmsToolDialog

    computeUpLevelLink, dialogTitle, getAdminTool, getCurrentToolPath, getParamBase, getParamForce, getParamPath, getParamRoot, getParamStyle, getParentPath, getToolManager, iconsBlockArea, iconsBlockAreaEnd, iconsBlockAreaStart, initAdminTool, pageBody, pageHtmlStyle, setParamBase, setParamForce, setParamPath, setParamRoot, setParamStyle, useNewStyle

    Methods inherited from class org.opencms.workplace.CmsWorkplace

    addMessages, addMessages, allParamsAsHidden, allParamsAsRequest, allParamValues, bodyEnd, bodyStart, bodyStart, buildSelect, buildSelect, button, button, buttonBar, buttonBar, buttonBarHorizontalLine, buttonBarLabel, buttonBarLabel, buttonBarLine, buttonBarLineSpacer, buttonBarSeparator, buttonBarSpacer, buttonBarStartTab, canEditPermissionsForRoles, checkLock, checkLock, decodeParamValue, fillParamValues, fillParamValues, generateCssStyle, generatePageEndExtended, generatePageEndSimple, generatePageStartExtended, generatePageStartSimple, getBroadcastMessageString, getCms, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, getStartSiteRoot, getStartSiteRoot, getStaticResourceUri, getStaticResourceUri, getStyleUri, getStyleUri, getStyleUri, getTemporaryFileName, getWorkplaceExplorerLink, getWorkplaceExplorerLink, getWorkplaceSettings, htmlEnd, initMessages, initSettings, initTimeWarp, initUserSettings, initWorkplaceMembers, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, isTemporaryFile, key, key, keyDefault, nullToEmpty, paramsAsHidden, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, substituteSiteTitle, substituteSiteTitleStatic, switchToCurrentProject, switchToTempProject, updateUserPreferences

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

    • CmsHelpTemplateBean

      public CmsHelpTemplateBean(org.opencms.jsp.CmsJspActionElement jsp)
      Public constructor with JSP action element.

      Parameters:
      jsp - an initialized JSP action element

    • CmsHelpTemplateBean

      public CmsHelpTemplateBean(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
      Public constructor with JSP variables.

      Parameters:
      context - the JSP page context
      req - the JSP request
      res - the JSP response

  • Method Details

    • buildOnlineHelpJavaScript

      public static String buildOnlineHelpJavaScript(Locale locale)
      Returns the java script method to open the online help window.

      Parameters:
      locale - the current users workplace Locale
      Returns:
      the java script method to open the online help window

    • buildHtmlHelpEnd

      public String buildHtmlHelpEnd()
      Returns the HTML for the end of the page.

      Returns:
      the HTML for the end of the page

    • buildHtmlHelpStart

      public String buildHtmlHelpStart(String cssFile, boolean transitional)
      Returns the HTML for the start of the page.

      Parameters:
      cssFile - the CSS file name to use
      transitional - if true, transitional doctype is used
      Returns:
      the HTML for the start of the page

    • displayBody

      public String displayBody()
      Returns the HTML for the body frame of the online help.

      Returns:
      the HTML for the body frame of the online help

    • displayHead

      public String displayHead()
      Returns the HTML for the head frame of the online help.

      Returns:
      the HTML for the head frame of the online help

    • displayHelp

      public String displayHelp() throws IOException
      Generates the HTML for the online help frameset or redirects to the help body, depending on the build frameset flag.

      Returns:
      the HTML for the online help frameset or an empty String (redirect)
      Throws:
      IOException - if redirection fails

    • getParamBuildframe

      public String getParamBuildframe()
      Returns the buildframe parameter indicating if the frameset should be generated.

      Returns:
      the buildframe parameter indicating if the frameset should be generated

    • getParamHelpresource

      public String getParamHelpresource()
      Returns the helpresource parameter value.

      Returns:
      the helpresource parameter value

    • getParamHomelink

      public String getParamHomelink()
      Returns the homelink parameter value.

      Returns:
      the homelink parameter value

    • getParamWorkplaceresource

      public String getParamWorkplaceresource()
      Returns the workplaceresource parameter value.

      Returns:
      the workplaceresource parameter value

    • setParamBuildframe

      public void setParamBuildframe(String buildframe)
      Sets the buildframe parameter indicating if the frameset should be generated.

      Parameters:
      buildframe - the buildframe parameter indicating if the frameset should be generated

    • setParamHelpresource

      public void setParamHelpresource(String helpresource)
      Sets the helpresource parameter value.

      Parameters:
      helpresource - the helpresource parameter value

    • setParamHomelink

      public void setParamHomelink(String homelink)
      Sets the homelink parameter value.

      Parameters:
      homelink - the homelink parameter value

    • setParamWorkplaceresource

      public void setParamWorkplaceresource(String workplaceresource)
      Sets the workplaceresource parameter value.

      Parameters:
      workplaceresource - the workplaceresource parameter value

    • buildHtmlHelpNavigation

      protected String buildHtmlHelpNavigation()
      Returns the HTML to build the navigation of the online help folder.

      Returns:
      the HTML to build the navigation of the online help folder

    • checkRole

      protected void checkRole() throws org.opencms.security.CmsRoleViolationException
      Overrides:
      checkRole in class org.opencms.workplace.CmsWorkplace
      Throws:
      org.opencms.security.CmsRoleViolationException
      See Also:
      • CmsWorkplace.checkRole()

    • displayFrameset

      protected String displayFrameset()
      Returns the HTML to build the frameset for the online help popup window.

      Returns:
      the HTML to build the frameset for the online help popup window

    • getMappedHelpUri

      protected void getMappedHelpUri()
      Determines the mapped help page for a given workplace resource URI.

      If a mapping information is found, the requested URI is set to the found value.

      If no workplace resource URI is given, nothing is changed.

    • initWorkplaceRequestValues

      protected void initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
      Overrides:
      initWorkplaceRequestValues in class org.opencms.workplace.CmsDialog
      See Also:
      • CmsWorkplace.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)

    • isBuildFrameset

      protected boolean isBuildFrameset()
      Returns true if the online help frameset has to be generated.

      Returns:
      true if the online help frameset has to be generated, otherwise false