| java.lang.Object
 biz.hammurapi.web.ActionsBase
biz.hammurapi.web.menu.HelpActions
| HelpActions | | public class HelpActions extends ActionsBase (Code) | | This class provides actions to render help topics
author:
Pavel |
| Method Summary | |
| public Object | menuHelp(HttpServletRequest request, HttpServletResponse response, ActionServlet servlet)
To generate help frame. | | public Object | menuTree(HttpServletRequest request, HttpServletResponse response, ActionServlet servlet)
| | public Object | page(HttpServletRequest request, HttpServletResponse response, ActionServlet servlet)
This method returns help content for a menu item in XML format. | | public Object | pdf(HttpServletRequest request, HttpServletResponse response, ActionServlet servlet)
| | public Object | search(HttpServletRequest request, HttpServletResponse response, ActionServlet servlet)
| | public Object | singlePage(HttpServletRequest request, HttpServletResponse response, ActionServlet servlet)
| | public String | topicContent(HttpServletRequest request, HttpServletResponse response, ActionServlet servlet)
This method returns topic content to be rendered in Ajax tooltip. |
| page | | public Object page(HttpServletRequest request, HttpServletResponse response, ActionServlet servlet) throws SQLException(Code) | | This method returns help content for a menu item in XML format. Help content is constructed from help topics, which don't
have slash character in their name. Construction rules:
1. Menu Description goes to DESCRIPTION xml element
2. Menu name goes to NAME
3. Menu title goes to TITLE
4. Help topic with name "main" becomes the top section. other topics become sub-sections in the main topic unless they have slash in their
names. Topics with # in their names become subtopics in the topics with the same prefix before #.
Topics with / in the name are not included to the menu item article but become additional articles mounted under the main article in the
help tree. Topics with names without slashes equal to name elements in "slashed" names are considered parents of those "slashed" topics.
Names with # characters preceding / character are considered illegal.
Parameters:
request -
Parameters:
response -
Parameters:
servlet -
throws:
SQLException - |
| topicContent | | public String topicContent(HttpServletRequest request, HttpServletResponse response, ActionServlet servlet) throws SQLException(Code) | | This method returns topic content to be rendered in Ajax tooltip.
Content is truncated to "db/max-tooltip-length" global parameter, which defaults to 2000.
Truncation rules:
1. if {{tooltip-end}} is present in the first max-tooltip-length character then toolip is truncated at that point.
2. Otherwise it is truncated at the end of the last paragraph which fits into max-tooltip-length.
3. If there is no such character then content is truncted at the last word which fits into max-tooltip-length.
If content is truncated then ellipsis (...) appears at the end of the content fragment or value of "tail" parameter.
Parameters:
request -
Parameters:
response -
Parameters:
servlet -
throws:
SQLException - |
| Methods inherited from biz.hammurapi.web.ActionsBase | protected static Object getGlobal(HttpServletRequest request, String name)(Code)(Java Doc)
protected Menu getMatched(HttpServletRequest request)(Code)(Java Doc)
protected Menu getMenu(HttpServletRequest request)(Code)(Java Doc)
public static String getReferrer(HttpServletRequest request)(Code)(Java Doc)
protected Object getRemoted(HttpServletRequest request, HttpServletResponse response, String name)(Code)(Java Doc)
protected String getUid()(Code)(Java Doc)
protected boolean hasPermission(HttpServletRequest request, Class clazz, String action)(Code)(Java Doc)
protected static boolean includeThisInPath(HttpServletRequest request)(Code)(Java Doc)
public void invoke(HttpServletRequest request, HttpServletResponse response) throws IOException(Code)(Java Doc)
public static boolean isBlank(String str)(Code)(Java Doc)
public void java(HttpServletRequest request, HttpServletResponse response, ActionServlet servlet) throws IOException(Code)(Java Doc)
public DomSerializable request2xml(HttpServletRequest request, HttpServletResponse response)(Code)(Java Doc)
protected void setReferrer(HttpServletRequest request, Attributable target)(Code)(Java Doc)
public Object sql(HttpServletRequest request, HttpServletResponse response, ActionServlet servlet) throws IOException(Code)(Java Doc)
|
|
|