com.wewebu.ow.server.app
Class OwHelpDialog

java.lang.Object
  com.wewebu.ow.server.ui.OwEventTarget
      com.wewebu.ow.server.ui.OwView
          com.wewebu.ow.server.ui.OwLayout
              com.wewebu.ow.server.ui.OwDialog
                  com.wewebu.ow.server.app.OwStandardDialog
                      com.wewebu.ow.server.app.OwHelpDialog

All Implemented Interfaces:

OwInfoView, OwBaseView, OwUpdateTarget

public class OwHelpDialog
extends OwStandardDialog
implements OwInfoView

Standard Dialog to display a help page within other dialogs.

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/interfaces inherited from class com.wewebu.ow.server.ui.OwDialog

OwDialog.OwDialogListener

Nested classes/interfaces inherited from class com.wewebu.ow.server.ui.OwLayout

OwLayout.OwDispatchRegion

Field Summary

protected static String

QUERY_STRING_KEY_HELPFILEPATH query key for the help path

Fields inherited from class com.wewebu.ow.server.app.OwStandardDialog

CLOSE_BTN_REGION, FOOTER_REGION, HELP_BTN_REGION, INFO_ICON_REGION, LEFT_REGION, m_strHelpPath, m_strInfoIconURL, m_strTitle, MAIN_REGION, MENU_REGION, RIGHT_REGION, STANDARD_DIALOG_REGION_MAX, TITLE_REGION

Fields inherited from class com.wewebu.ow.server.ui.OwDialog

m_iDEBUG_DocumentViewSize, m_iDEBUG_InitDocument, m_iDEBUG_TargetCount, m_Listener

Fields inherited from class com.wewebu.ow.server.ui.OwLayout

m_Regions

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

OwHelpDialog(String strTitle_p, String strHelpPath_p)
constructor set the help to display

Method Summary

String	getLink(String strPath_p, String strName_p, String strClass_p) create a link to another JSP info page
boolean	hasHelpButton() check if the help is set overridden from OwStandardDialog
boolean	isRegion(int iRegion_p) determine if region exists
void	onBack(javax.servlet.http.HttpServletRequest request_p) called when user clicked the back button
void	onOpenHelpLink(javax.servlet.http.HttpServletRequest request_p) called when user clicked on a help link
void	renderRegion(Writer w_p, int iRegion_p) render the views of the region

Methods inherited from class com.wewebu.ow.server.app.OwStandardDialog

getInfoIcon, getTitle, onClose, onHelp, onRender, renderCloseButton, renderHelpButton, setHelp, setInfoIcon, setTitle

Methods inherited from class com.wewebu.ow.server.ui.OwDialog

closeDialog, setListener

Methods inherited from class com.wewebu.ow.server.ui.OwLayout

addRegion, addView, addView, addViewReference, getIterator, getViewRegion, isRegionMaximized, isRegionMinimized, isRegionNormal, renderNamedRegion

Methods inherited from class com.wewebu.ow.server.ui.OwView

activate, detach, getBreadcrumbPart, getDocument, getExternalFormEventTarget, getFormName, getFormTarget, getIcon, getMaximizeView, getParent, getRenderedNamedRegion, getRenderedRegion, getViewList, init, isFormTargetExternal, isNamedRegion, isShowMaximized, isShowMinimized, isShowNormal, onActivate, onUpdate, render, renderHTMLFormular, 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

OwHelpDialog

public OwHelpDialog(String strTitle_p,
                    String strHelpPath_p)

constructor set the help to display

Parameters:

strTitle_p - Title to display

strHelpPath_p - Help path to the JSP help

Method Detail

hasHelpButton

public boolean hasHelpButton()

check if the help is set overridden from OwStandardDialog

Overrides:

hasHelpButton in class OwStandardDialog

Returns:

always false, the help view must not contain a help button.

isRegion

public boolean isRegion(int iRegion_p)

determine if region exists

Specified by:

isRegion in interface OwBaseView

Overrides:

isRegion in class OwStandardDialog

Parameters:

iRegion_p - ID of the region to render

Returns:

true if region contains anything and should be rendered

renderRegion

public void renderRegion(Writer w_p,
                         int iRegion_p)
                  throws Exception

render the views of the region

Specified by:

renderRegion in interface OwBaseView

Overrides:

renderRegion in class OwStandardDialog

Parameters:

w_p - Writer object to write HTML to

iRegion_p - ID of the region to render

Throws:

Exception

onBack

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

called when user clicked the back button

Parameters:

request_p - a HttpServletRequest object

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

getLink

public String getLink(String strPath_p,
                      String strName_p,
                      String strClass_p)
               throws Exception

create a link to another JSP info page

Specified by:

getLink in interface OwInfoView

Parameters:

strPath_p - the requested info page

strName_p - the link name to display

strClass_p - the CSS class to use

Returns:

String with HTML anchor

Throws:

Exception