com.wewebu.ow.server.app
Class OwStandardDialog

java.lang.Object
  extended by com.wewebu.ow.server.ui.OwEventTarget
      extended by com.wewebu.ow.server.ui.OwView
          extended by com.wewebu.ow.server.ui.OwLayout
              extended by com.wewebu.ow.server.ui.OwDialog
                  extended by com.wewebu.ow.server.app.OwStandardDialog
All Implemented Interfaces:
OwBaseView, OwUpdateTarget
Direct Known Subclasses:
OwAddPrivilegeDialog, OwCreateObjectDialog, OwCreateObjectFormularDialog, OwHelpDialog, OwMessageBox, OwStandardSequenceDialog, OwUserSelectDialog

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


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
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
 
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
OwStandardDialog()
           
 
Method Summary
 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
 
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

CLOSE_BTN_REGION

public static final int CLOSE_BTN_REGION
the close button region

See Also:
Constant Field Values

MAIN_REGION

public static final int MAIN_REGION
the main region

See Also:
Constant Field Values

TITLE_REGION

public static final int TITLE_REGION
the title region

See Also:
Constant Field Values

HELP_BTN_REGION

public static final int HELP_BTN_REGION
the help button region

See Also:
Constant Field Values

INFO_ICON_REGION

public static final int INFO_ICON_REGION
the info icon region

See Also:
Constant Field Values

MENU_REGION

public static final int MENU_REGION
the info icon region

See Also:
Constant Field Values

FOOTER_REGION

public static final int FOOTER_REGION
the footer region

See Also:
Constant Field Values

LEFT_REGION

public static final int LEFT_REGION
the left region

See Also:
Constant Field Values

RIGHT_REGION

public static final int RIGHT_REGION
the right region

See Also:
Constant Field Values

STANDARD_DIALOG_REGION_MAX

public static final int STANDARD_DIALOG_REGION_MAX
start of overridden regions

See Also:
Constant Field Values

m_strHelpPath

protected String m_strHelpPath
Help path to the JSP help


m_strTitle

protected String m_strTitle
dialog title


m_strInfoIconURL

protected String m_strInfoIconURL
URL to the info icon to display

Constructor Detail

OwStandardDialog

public OwStandardDialog()
Method Detail

setInfoIcon

public void setInfoIcon(String strInfoIconURL_p)
set the URL to the info icon

Parameters:
strInfoIconURL_p - String

getInfoIcon

public String getInfoIcon()
get the URL to the info icon

Returns:
String

setTitle

public void setTitle(String strTitle_p)
set dialog title

Parameters:
strTitle_p - String

getTitle

public String getTitle()
Description copied from class: OwView
overridable title of the view

Specified by:
getTitle in interface OwBaseView
Overrides:
getTitle in class OwView
Returns:
String localized display name for the view

setHelp

public void setHelp(String strHelpPath_p)
set the current path to the help for context sensitive online help

Parameters:
strHelpPath_p - Help path to the JSP help

isRegion

public boolean isRegion(int iRegion_p)
determine if region contains a view

Specified by:
isRegion in interface OwBaseView
Overrides:
isRegion in class OwLayout
Parameters:
iRegion_p - ID of the region to render
Returns:
true if region contains anything and should be rendered

hasHelpButton

public boolean hasHelpButton()
check if the help is set

Returns:
true = help is set, false otherwise

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 OwLayout
Parameters:
w_p - Writer object to write HTML to
iRegion_p - ID of the region to render
Throws:
Exception

renderHelpButton

public void renderHelpButton(Writer w_p)
                      throws Exception
render Help button

Parameters:
w_p -
Throws:
Exception
Since:
3.1.0.0

renderCloseButton

public void renderCloseButton(Writer w_p)
                       throws Exception
render Close button

Parameters:
w_p -
Throws:
Exception
Since:
3.1.0.0

onHelp

public void onHelp(javax.servlet.http.HttpServletRequest request_p)
            throws Exception
event called when user clicked help on the dialog

Parameters:
request_p - HttpServletRequest
Throws:
Exception

onClose

public void onClose(javax.servlet.http.HttpServletRequest request_p)
             throws Exception
event called when user clicked a close on the dialog

Parameters:
request_p - HttpServletRequest
Throws:
Exception

onRender

protected void onRender(Writer w_p)
                 throws Exception
render the view

Overrides:
onRender in class OwView
Parameters:
w_p - Writer object to write HTML to
Throws:
Exception


Copyright © 2013 Alfresco Business Solutions. All Rights Reserved.