|
| |
|
| org.opencms.workplace.CmsDialog
 org.opencms.workplace.help.CmsHelpTemplateBean
| CmsHelpTemplateBean | | public class CmsHelpTemplateBean extends CmsDialog (Code) | | 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
org.opencms.jsp.CmsJspActionElement.getContent(String)
appended after their own output. This allows to use jsp's in the online help template.
author:
Andreas Zahner
author:
Achim Westermann
version:
$Revision: 1.24 $
since:
6.0.0 |
| DEFAULT_HELPFILE | | final public static String DEFAULT_HELPFILE(Code) | | File name of the default help file to load.
|
| HELPMAPPINGS_FILENAME | | final public static String HELPMAPPINGS_FILENAME(Code) | | File name of the help mappings properties file(s).
|
| MODULE_NAME | | final public static String MODULE_NAME(Code) | | The name of the help module.
|
| PARAM_BUILDFRAME | | final public static String PARAM_BUILDFRAME(Code) | | Request parameter name for the buildframe flag parameter.
|
| PARAM_HELPRESOURCE | | final public static String PARAM_HELPRESOURCE(Code) | | Request parameter name for the helpresource uri.
|
| PARAM_HOMELINK | | final public static String PARAM_HOMELINK(Code) | | Request parameter name for the homelink in head frame.
|
| PARAM_WORKPLACERESOURCE | | final public static String PARAM_WORKPLACERESOURCE(Code) | | Request parameter name for the workplaceresource uri.
|
| PATH_HELP | | final public static String PATH_HELP(Code) | | VFS path to the help folder, contains a macro for the Locale which has to be resolved.
|
| PROPERTY_VALUE_HELPSTART | | final public static String PROPERTY_VALUE_HELPSTART(Code) | | Value of the NavInfo property indicating the start folder of the help.
|
| RFS_HELPMAPPINGS | | final public static String RFS_HELPMAPPINGS(Code) | | Relative RFS path of the help mappings property file(s).
|
| TEMPLATEPATH | | final public static String TEMPLATEPATH(Code) | | Absolute path to used JSP templates.
|
| CmsHelpTemplateBean | | public CmsHelpTemplateBean(CmsJspActionElement jsp)(Code) | | Public constructor with JSP action element.
Parameters:
jsp - an initialized JSP action element |
| CmsHelpTemplateBean | | public CmsHelpTemplateBean(PageContext context, HttpServletRequest req, HttpServletResponse res)(Code) | | Public constructor with JSP variables.
Parameters:
context - the JSP page context
Parameters:
req - the JSP request
Parameters:
res - the JSP response |
| buildHtmlHelpEnd | | public String buildHtmlHelpEnd()(Code) | | Returns the HTML for the end of the page.
the HTML for the end of the page |
| buildHtmlHelpNavigation | | protected String buildHtmlHelpNavigation()(Code) | | Returns the HTML to build the navigation of the online help folder.
the HTML to build the navigation of the online help folder |
| buildHtmlHelpStart | | public String buildHtmlHelpStart(String cssFile, boolean transitional)(Code) | | Returns the HTML for the start of the page.
Parameters:
cssFile - the CSS file name to use
Parameters:
transitional - if true, transitional doctype is used the HTML for the start of the page |
| buildOnlineHelpJavaScript | | public static String buildOnlineHelpJavaScript(Locale locale)(Code) | | Returns the java script method to open the online help popup window.
Parameters:
locale - the current users workplace Locale the java script method to open the online help popup window |
| displayBody | | public String displayBody()(Code) | | Returns the HTML for the body frame of the online help.
the HTML for the body frame of the online help |
| displayFrameset | | protected String displayFrameset()(Code) | | Returns the HTML to build the frameset for the online help popup window.
the HTML to build the frameset for the online help popup window |
| displayHead | | public String displayHead()(Code) | | Returns the HTML for the head frame of the online help.
the HTML for the head frame of the online help |
| displayHelp | | public String displayHelp() throws IOException(Code) | | Generates the HTML for the online help frameset or redirects to the help body, depending on the build frameset flag.
the HTML for the online help frameset or an empty String (redirect)
throws:
IOException - if redirection fails |
| getMappedHelpUri | | protected void getMappedHelpUri()(Code) | | 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.
|
| getParamBuildframe | | public String getParamBuildframe()(Code) | | Returns the buildframe parameter indicating if the frameset should be generated.
the buildframe parameter indicating if the frameset should be generated |
| getParamHelpresource | | public String getParamHelpresource()(Code) | | Returns the helpresource parameter value.
the helpresource parameter value |
| getParamHomelink | | public String getParamHomelink()(Code) | | Returns the homelink parameter value.
the homelink parameter value |
| getParamWorkplaceresource | | public String getParamWorkplaceresource()(Code) | | Returns the workplaceresource parameter value.
the workplaceresource parameter value |
| isBuildFrameset | | protected boolean isBuildFrameset()(Code) | | Returns true if the online help frameset has to be generated.
true if the online help frameset has to be generated, otherwise false |
| setParamBuildframe | | public void setParamBuildframe(String buildframe)(Code) | | 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)(Code) | | Sets the helpresource parameter value.
Parameters:
helpresource - the helpresource parameter value |
| setParamHomelink | | public void setParamHomelink(String homelink)(Code) | | Sets the homelink parameter value.
Parameters:
homelink - the homelink parameter value |
| setParamWorkplaceresource | | public void setParamWorkplaceresource(String workplaceresource)(Code) | | Sets the workplaceresource parameter value.
Parameters:
workplaceresource - the workplaceresource parameter value |
| Methods inherited from org.opencms.workplace.CmsDialog | public void actionCloseDialog() throws JspException(Code)(Java Doc)
protected String appendDelimiter(String attribute)(Code)(Java Doc)
public String buildAjaxResultContainer(String title)(Code)(Java Doc)
protected String buildAjaxWaitMessage()(Code)(Java Doc)
public String buildLockAdditionalOptions()(Code)(Java Doc)
public String buildLockConfirmationMessageJS()(Code)(Java Doc)
public String buildLockDialog() throws CmsException(Code)(Java Doc)
public String buildLockDialog(CmsLockFilter nonBlockingFilter, CmsLockFilter blockingFilter, int hiddenTimeout, boolean includeRelated) throws CmsException(Code)(Java Doc)
public String buildLockHeaderBox() throws CmsException(Code)(Java Doc)
protected boolean checkResourcePermissions(CmsPermissionSet required, boolean neededForFolder)(Code)(Java Doc)
protected boolean checkResourcePermissions(CmsPermissionSet required, boolean neededForFolder, CmsMessageContainer errorMessage)(Code)(Java Doc)
protected String computeCurrentFolder()(Code)(Java Doc)
public String dialog(int segment, String attributes)(Code)(Java Doc)
public String dialogBlock(int segment, String headline, boolean error)(Code)(Java Doc)
public String dialogBlockEnd()(Code)(Java Doc)
public String dialogBlockStart(String headline)(Code)(Java Doc)
public String dialogButtonRow(int segment)(Code)(Java Doc)
public String dialogButtonRowEnd()(Code)(Java Doc)
public String dialogButtonRowStart()(Code)(Java Doc)
public String dialogButtons(int[] buttons, String[] attributes)(Code)(Java Doc)
public String dialogButtonsClose()(Code)(Java Doc)
public String dialogButtonsClose(String closeAttribute)(Code)(Java Doc)
public String dialogButtonsCloseDetails(String closeAttribute, String detailsAttribute)(Code)(Java Doc)
protected void dialogButtonsHtml(StringBuffer result, int button, String attribute)(Code)(Java Doc)
public String dialogButtonsOk()(Code)(Java Doc)
public String dialogButtonsOk(String okAttribute)(Code)(Java Doc)
public String dialogButtonsOkCancel()(Code)(Java Doc)
public String dialogButtonsOkCancel(String okAttributes, String cancelAttributes)(Code)(Java Doc)
public String dialogButtonsOkCancelAdvanced(String okAttributes, String cancelAttributes, String advancedAttributes)(Code)(Java Doc)
public String dialogButtonsSetOkCancel(String setAttributes, String okAttributes, String cancelAttributes)(Code)(Java Doc)
public String dialogContent(int segment, String title)(Code)(Java Doc)
public String dialogContentEnd()(Code)(Java Doc)
public String dialogContentStart(String title)(Code)(Java Doc)
public String dialogEnd()(Code)(Java Doc)
public String dialogHead(String title)(Code)(Java Doc)
public String dialogHorizontalSpacer(int width)(Code)(Java Doc)
public String dialogLockButtons()(Code)(Java Doc)
public String dialogRow(int segment)(Code)(Java Doc)
public String dialogRowEnd()(Code)(Java Doc)
public String dialogRowStart()(Code)(Java Doc)
public String dialogScriptSubmit()(Code)(Java Doc)
public String dialogSeparator()(Code)(Java Doc)
public String dialogSpacer()(Code)(Java Doc)
public String dialogStart()(Code)(Java Doc)
public String dialogStart(String attributes)(Code)(Java Doc)
public String dialogSubheadline(String headline)(Code)(Java Doc)
public String dialogToggleStart(String headline, String id, boolean show)(Code)(Java Doc)
public String dialogWhiteBox(int segment)(Code)(Java Doc)
public String dialogWhiteBoxEnd()(Code)(Java Doc)
public String dialogWhiteBoxStart()(Code)(Java Doc)
public int getAction()(Code)(Java Doc)
protected String getAdministrationBackLink()(Code)(Java Doc)
public String getCancelAction()(Code)(Java Doc)
public String getDialogRealUri()(Code)(Java Doc)
public String getDialogUri()(Code)(Java Doc)
public String getOnlineHelpUriCustom()(Code)(Java Doc)
public String getParamAction()(Code)(Java Doc)
public String getParamCloseLink()(Code)(Java Doc)
public String getParamDialogtype()(Code)(Java Doc)
public String getParamFramename()(Code)(Java Doc)
public String getParamIsPopup()(Code)(Java Doc)
public String getParamMessage()(Code)(Java Doc)
public String getParamOriginalParams()(Code)(Java Doc)
public String getParamPreActionDone()(Code)(Java Doc)
public String getParamRedirect()(Code)(Java Doc)
public String getParamResource()(Code)(Java Doc)
public String getParamTitle()(Code)(Java Doc)
public String getState() throws CmsException(Code)(Java Doc)
public boolean hasCorrectLockstate()(Code)(Java Doc)
public boolean hasSiblings()(Code)(Java Doc)
public String htmlStart()(Code)(Java Doc)
public String htmlStart(String helpUrl)(Code)(Java Doc)
public String htmlStart(String helpUrl, String title)(Code)(Java Doc)
public String htmlStartStyle(String title, String stylesheet)(Code)(Java Doc)
public void includeErrorpage(CmsWorkplace wp, Throwable t) throws JspException(Code)(Java Doc)
public static CmsDialog initCmsDialog(PageContext context, HttpServletRequest req, HttpServletResponse res)(Code)(Java Doc)
protected void initWorkplaceRequestValues(CmsWorkplaceSettings settings, HttpServletRequest request)(Code)(Java Doc)
public boolean isPopup()(Code)(Java Doc)
public boolean isPreEditor()(Code)(Java Doc)
public String pageHtml(int segment, String helpUrl)(Code)(Java Doc)
public String pageHtml(int segment, String helpUrl, String title)(Code)(Java Doc)
protected void setAction(int value)(Code)(Java Doc)
public void setOnlineHelpUriCustom(String uri)(Code)(Java Doc)
public void setParamAction(String value)(Code)(Java Doc)
public void setParamCloseLink(String value)(Code)(Java Doc)
public void setParamDialogtype(String value)(Code)(Java Doc)
public void setParamFramename(String value)(Code)(Java Doc)
public void setParamIsPopup(String value)(Code)(Java Doc)
public void setParamMessage(String value)(Code)(Java Doc)
public void setParamOriginalParams(String paramOriginalParams)(Code)(Java Doc)
public void setParamPreActionDone(String paramPreActionDone)(Code)(Java Doc)
public void setParamRedirect(String redirect)(Code)(Java Doc)
public void setParamResource(String value)(Code)(Java Doc)
public void setParamTitle(String value)(Code)(Java Doc)
|
|
|
|