|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.wewebu.ow.server.ui.OwEventTarget
com.wewebu.ow.server.ui.OwView
com.wewebu.ow.server.app.OwMasterView
com.wewebu.ow.server.plug.owhelp.OwHelpView
public class OwHelpView
Help View.
Alfresco Workdesk
Copyright (c) Alfresco Software, Inc.
All rights reserved.
For licensing information read the license.txt file or
go to: http://wiki.alfresco.com
Nested Class Summary | |
---|---|
class |
OwHelpView.OwHelpCollection
|
Field Summary | |
---|---|
protected static String |
QUERY_STRING_KEY_HELPFILEPATH
query key for the help path |
Fields inherited from class com.wewebu.ow.server.ui.OwView |
---|
CURRENT_MODULE_KEY, FORMULAR_PLACEHOLDER_END_DELIMITER, FORMULAR_PLACEHOLDER_START_DELIMITER, m_externalFormEventTarget |
Fields inherited from interface com.wewebu.ow.server.ui.OwBaseView |
---|
EMPTY_STRING |
Constructor Summary | |
---|---|
OwHelpView()
|
Method Summary | |
---|---|
String |
getLink(String strHelpPath_p,
String strName_p,
String strClass_p)
overwritten from OwInfoView: create a link to another JSP info page |
protected void |
init()
called when the view should create its HTML content to be displayed |
protected void |
onActivate(int iIndex_p,
Object oReason_p)
activate the target from a navigation module. |
void |
onOpenHelpLink(javax.servlet.http.HttpServletRequest request_p)
called when user clicked on a help link |
protected void |
onRender(Writer w_p)
called by the framework to render the view |
protected void |
renderChapterIndex(Writer w_p,
OwHelpView.OwHelpCollection helpEntry_p)
render a chapter index area |
protected void |
renderChapters(Writer w_p)
render the chapters |
protected void |
renderHelpText(Writer w_p)
render the help text |
void |
setHelpJsp(String sLink_p)
set a JSP page to display as help text |
void |
setOwHelpCollection(String strPluginType_p,
String strDisplayName_p)
called when the view should create its HTML content to be displayed |
Methods inherited from class com.wewebu.ow.server.app.OwMasterView |
---|
getBreadcrumbPart, getConfigNode, getConfiguration, getDialogManager, getIcon, getPlugin, getPluginID, getTitle |
Methods inherited from class com.wewebu.ow.server.ui.OwView |
---|
activate, addView, detach, getDocument, getExternalFormEventTarget, getFormName, getFormTarget, getIterator, getMaximizeView, getParent, getRenderedNamedRegion, getRenderedRegion, getViewList, isFormTargetExternal, isNamedRegion, isRegion, isShowMaximized, isShowMinimized, isShowNormal, onUpdate, render, renderHTMLFormular, renderNamedRegion, renderRegion, serverSideDesignInclude, serverSideInclude, setDocument, setExternalFormTarget, setMaximizeView, setParent, showMaximized, showMinimized, showNormal, usesFormWithAttributes |
Methods inherited from class com.wewebu.ow.server.ui.OwEventTarget |
---|
attach, disableRequestListener, enableRequestListener, getAjaxEventURL, getContext, getEventURL, getFormEventFunction, getFormEventURL, getID, onExternalRequest, onFormEvent, onRequest, updateExternalFormTarget |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static final String QUERY_STRING_KEY_HELPFILEPATH
Constructor Detail |
---|
public OwHelpView()
Method Detail |
---|
protected void init() throws Exception
init
in class com.wewebu.ow.server.app.OwMasterView
Exception
public void setOwHelpCollection(String strPluginType_p, String strDisplayName_p) throws Exception
strPluginType_p
- for the plugin name to usestrDisplayName_p
- for the name the is to display
Exception
public void onOpenHelpLink(javax.servlet.http.HttpServletRequest request_p) throws Exception
request_p
- a HttpServletRequest object
Exception
protected void onRender(Writer w_p) throws Exception
onRender
in class com.wewebu.ow.server.ui.OwView
w_p
- Writer
Exception
protected void renderChapters(Writer w_p) throws Exception
w_p
- Writer
Exception
public void setHelpJsp(String sLink_p)
protected void renderHelpText(Writer w_p) throws Exception
w_p
- Writer
Exception
protected void renderChapterIndex(Writer w_p, OwHelpView.OwHelpCollection helpEntry_p) throws Exception
w_p
- WriterhelpEntry_p
- OwHelpCollection
Exception
public String getLink(String strHelpPath_p, String strName_p, String strClass_p)
getLink
in interface com.wewebu.ow.server.app.OwInfoView
strHelpPath_p
- the requested info pagestrName_p
- the link name to displaystrClass_p
- the CSS class to use
protected void onActivate(int iIndex_p, Object oReason_p) throws Exception
onActivate
in class com.wewebu.ow.server.app.OwMasterView
iIndex_p
- int
tab index of NavigationoReason_p
- User Object which was submitted when target was attached to the navigation module
Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |