public class OwStandardDialog extends OwDialog
Standard Dialog Layout for Workdesk. Displays a close button in the head area.
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 |
---|---|
static int |
CLOSE_BTN_REGION
the close button region
|
static int |
FOOTER_REGION
the footer region
|
static int |
HELP_BTN_REGION
the help button region
|
static int |
INFO_ICON_REGION
the info icon region
|
static int |
LEFT_REGION
the left region
|
protected String |
m_strHelpPath
Help path to the JSP help
|
protected String |
m_strInfoIconURL
URL to the info icon to display
|
protected String |
m_strTitle
dialog title
|
static int |
MAIN_REGION
the main region
|
static int |
MENU_REGION
the info icon region
|
static int |
RIGHT_REGION
the right region
|
static int |
STANDARD_DIALOG_REGION_MAX
start of overridden regions
|
static int |
TITLE_REGION
the 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 |
---|
OwStandardDialog() |
Modifier and Type | Method and Description |
---|---|
String |
getInfoIcon()
get the URL to the info icon
|
String |
getTitle()
overridable title of the view
|
boolean |
hasHelpButton()
check if the help is set
|
boolean |
isRegion(int iRegion_p)
determine if region contains a view
|
void |
onClose(javax.servlet.http.HttpServletRequest request_p)
event called when user clicked a close on the dialog
|
void |
onHelp(javax.servlet.http.HttpServletRequest request_p)
event called when user clicked help on the dialog
|
protected void |
onRender(Writer w_p)
render the view
|
void |
renderCloseButton(Writer w_p)
render Close button
|
void |
renderHelpButton(Writer w_p)
render Help button
|
void |
renderRegion(Writer w_p,
int iRegion_p)
render the views of the region
|
void |
setHelp(String strHelpPath_p)
set the current path to the help for context sensitive online help
|
void |
setInfoIcon(String strInfoIconURL_p)
set the URL to the info icon
|
void |
setTitle(String strTitle_p)
set dialog title
|
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
public static final int CLOSE_BTN_REGION
public static final int MAIN_REGION
public static final int TITLE_REGION
public static final int HELP_BTN_REGION
public static final int INFO_ICON_REGION
public static final int MENU_REGION
public static final int FOOTER_REGION
public static final int LEFT_REGION
public static final int RIGHT_REGION
public static final int STANDARD_DIALOG_REGION_MAX
protected String m_strHelpPath
protected String m_strTitle
protected String m_strInfoIconURL
public void setInfoIcon(String strInfoIconURL_p)
strInfoIconURL_p
- Stringpublic String getInfoIcon()
public void setTitle(String strTitle_p)
strTitle_p
- Stringpublic String getTitle()
OwView
getTitle
in interface OwBaseView
getTitle
in class OwView
public void setHelp(String strHelpPath_p)
strHelpPath_p
- Help path to the JSP helppublic boolean isRegion(int iRegion_p)
isRegion
in interface OwBaseView
isRegion
in class OwLayout
iRegion_p
- ID of the region to renderpublic boolean hasHelpButton()
public void renderRegion(Writer w_p, int iRegion_p) throws Exception
renderRegion
in interface OwBaseView
renderRegion
in class OwLayout
w_p
- Writer object to write HTML toiRegion_p
- ID of the region to renderException
public void renderHelpButton(Writer w_p) throws Exception
w_p
- Exception
public void renderCloseButton(Writer w_p) throws Exception
w_p
- Exception
public void onHelp(javax.servlet.http.HttpServletRequest request_p) throws Exception
request_p
- HttpServletRequestException
public void onClose(javax.servlet.http.HttpServletRequest request_p) throws Exception
request_p
- HttpServletRequestException
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.