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
OwDialog.OwDialogListener
OwLayout.OwDispatchRegion, OwLayout.OwLayoutViewRefrence
Modifier and Type | Field and Description |
---|---|
protected static String |
QUERY_STRING_KEY_HELPFILEPATH
query key for the help path
|
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
m_iDEBUG_DocumentViewSize, m_iDEBUG_InitDocument, m_iDEBUG_TargetCount, m_Listener
CURRENT_MODULE_KEY, FORMULAR_PLACEHOLDER_END_DELIMITER, FORMULAR_PLACEHOLDER_START_DELIMITER, m_externalFormEventTarget
EMPTY_STRING
Constructor and Description |
---|
OwHelpDialog(String strTitle_p,
String strHelpPath_p)
constructor set the help to display
|
Modifier and Type | Method and Description |
---|---|
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
|
getInfoIcon, getTitle, onClose, onHelp, onRender, renderCloseButton, renderHelpButton, setHelp, setInfoIcon, setTitle
closeDialog, setListener
addRegion, addView, addView, addViewReference, getIterator, getViewRegion, isRegionMaximized, isRegionMinimized, isRegionNormal, renderNamedRegion
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
attach, disableRequestListener, enableRequestListener, getAjaxEventURL, getContext, getEventURL, getFormEventFunction, getFormEventURL, getID, onExternalRequest, onFormEvent, onRequest, updateExternalFormTarget
protected static final String QUERY_STRING_KEY_HELPFILEPATH
public boolean hasHelpButton()
hasHelpButton
in class OwStandardDialog
public boolean isRegion(int iRegion_p)
isRegion
in interface OwBaseView
isRegion
in class OwStandardDialog
iRegion_p
- ID of the region to renderpublic void renderRegion(Writer w_p, int iRegion_p) throws Exception
renderRegion
in interface OwBaseView
renderRegion
in class OwStandardDialog
w_p
- Writer object to write HTML toiRegion_p
- ID of the region to renderException
public void onBack(javax.servlet.http.HttpServletRequest request_p) throws Exception
request_p
- a HttpServletRequest objectException
public void onOpenHelpLink(javax.servlet.http.HttpServletRequest request_p) throws Exception
request_p
- a HttpServletRequest objectException
public String getLink(String strPath_p, String strName_p, String strClass_p) throws Exception
getLink
in interface OwInfoView
strPath_p
- the requested info pagestrName_p
- the link name to displaystrClass_p
- the CSS class to useException
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.