public class OwHelpView
extends com.wewebu.ow.server.app.OwMasterView
implements com.wewebu.ow.server.app.OwInfoView
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
Modifier and Type | Class and Description |
---|---|
class |
OwHelpView.OwHelpCollection |
Modifier and Type | Field and Description |
---|---|
protected static String |
QUERY_STRING_KEY_HELPFILEPATH
query key for the help path
|
Constructor and Description |
---|
OwHelpView() |
Modifier and Type | Method and Description |
---|---|
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
|
getBreadcrumbPart, getConfigNode, getConfiguration, getDialogManager, getIcon, getPlugin, getPluginID, getTitle
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
protected static final String QUERY_STRING_KEY_HELPFILEPATH
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 displayException
public void onOpenHelpLink(javax.servlet.http.HttpServletRequest request_p) throws Exception
request_p
- a HttpServletRequest objectException
protected void onRender(Writer w_p) throws Exception
onRender
in class com.wewebu.ow.server.ui.OwView
w_p
- WriterException
protected void renderChapters(Writer w_p) throws Exception
w_p
- WriterException
public void setHelpJsp(String sLink_p)
protected void renderHelpText(Writer w_p) throws Exception
w_p
- WriterException
protected void renderChapterIndex(Writer w_p, OwHelpView.OwHelpCollection helpEntry_p) throws Exception
w_p
- WriterhelpEntry_p
- OwHelpCollectionException
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 useprotected 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 moduleException
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.