com.wewebu.ow.server.plug.owhelp

Class OwHelpView

java.lang.Object

com.wewebu.ow.server.ui.OwEventTarget

com.wewebu.ow.server.ui.OwView

com.wewebu.ow.server.app.OwMasterView

com.wewebu.ow.server.plug.owhelp.OwHelpView

All Implemented Interfaces:

com.wewebu.ow.server.app.OwInfoView, com.wewebu.ow.server.ui.OwBaseView, com.wewebu.ow.server.ui.OwUpdateTarget

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	OwHelpView.OwHelpCollection

Field Summary

Fields

Modifier and Type	Field and Description
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

Constructors

Constructor and Description
OwHelpView()

Method Summary

Methods

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

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

QUERY_STRING_KEY_HELPFILEPATH

protected static final String QUERY_STRING_KEY_HELPFILEPATH

query key for the help path

See Also:

Constant Field Values

Constructor Detail

OwHelpView

public OwHelpView()

Method Detail

init

protected void init()
             throws Exception

called when the view should create its HTML content to be displayed

Overrides:

init in class com.wewebu.ow.server.app.OwMasterView

Throws:

Exception

setOwHelpCollection

public void setOwHelpCollection(String strPluginType_p,
                       String strDisplayName_p)
                         throws Exception

called when the view should create its HTML content to be displayed

Parameters:

strPluginType_p - for the plugin name to use

strDisplayName_p - for the name the is to display

Throws:

Exception

onOpenHelpLink

public void onOpenHelpLink(javax.servlet.http.HttpServletRequest request_p)
                    throws Exception

called when user clicked on a help link

Parameters:

request_p - a HttpServletRequest object

Throws:

Exception

onRender

protected void onRender(Writer w_p)
                 throws Exception

called by the framework to render the view

Overrides:

onRender in class com.wewebu.ow.server.ui.OwView

Parameters:

w_p - Writer

Throws:

Exception

renderChapters

protected void renderChapters(Writer w_p)
                       throws Exception

render the chapters

Parameters:

w_p - Writer

Throws:

Exception

setHelpJsp

public void setHelpJsp(String sLink_p)

set a JSP page to display as help text

renderHelpText

protected void renderHelpText(Writer w_p)
                       throws Exception

render the help text

Parameters:

w_p - Writer

Throws:

Exception

renderChapterIndex

protected void renderChapterIndex(Writer w_p,
                      OwHelpView.OwHelpCollection helpEntry_p)
                           throws Exception

render a chapter index area

Parameters:

w_p - Writer

helpEntry_p - OwHelpCollection

Throws:

Exception

getLink

public String getLink(String strHelpPath_p,
             String strName_p,
             String strClass_p)

overwritten from OwInfoView: create a link to another JSP info page

Specified by:

getLink in interface com.wewebu.ow.server.app.OwInfoView

Parameters:

strHelpPath_p - the requested info page

strName_p - the link name to display

strClass_p - the CSS class to use

Returns:

String with HTML anchor

onActivate

protected void onActivate(int iIndex_p,
              Object oReason_p)
                   throws Exception

activate the target from a navigation module. Called when menu item was pressed for this target.

Overrides:

onActivate in class com.wewebu.ow.server.app.OwMasterView

Parameters:

iIndex_p - int tab index of Navigation

oReason_p - User Object which was submitted when target was attached to the navigation module

Throws:

Exception