com.wewebu.ow.server.plug.owrecord
Class OwRecordSubLayout

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.app.OwSubLayout
                  extended by com.wewebu.ow.server.plug.owrecord.OwRecordSubLayout
All Implemented Interfaces:
com.wewebu.ow.server.ui.OwBaseView, com.wewebu.ow.server.ui.OwUpdateTarget

public class OwRecordSubLayout
extends com.wewebu.ow.server.app.OwSubLayout

Layout of the Record plugin 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.OwLayout
com.wewebu.ow.server.ui.OwLayout.OwDispatchRegion
 
Field Summary
static String AJAX_UPDATE_DND_APPLET_REGION
           
static String AJAX_UPDATE_HOTKEY_REGION
           
static String AJAX_UPDATE_MENU_REGION
           
static String AJAX_UPDATE_SEARCH_TEMPLATES_REGION
           
static String AJAX_UPDATE_SUB_LAYOUT_MENU
          The event name for update the OW_SUB_LAYOUT_MENU_DIV_ID div.
protected static String DEFAULT_JSP_FORM
          path to the default JSP form, to be used for rendering.
protected static String JSP_FORM_ELEMENT_NAME
          the name of the element containing the path to the JSP used for rendering
static int NAVIGATION_REGION_REGISTER_MODE
          region of the the treeview in register optional mode
static String OW_REGION_DND_APPLET_DIV_ID
           
static String OW_REGION_HOTKEY_DIV_ID
           
static String OW_REGION_MENU_DIV_ID
           
static String OW_REGION_SEARCHTEMPLATE_DIV_ID
           
static String OW_SUB_LAYOUT_MENU_DIV_ID
          The sub layout menu div id.
static int PREVIEW_PROPERTY_REGION
          region of the property preview
static int SEARCH_TEMPLATE_REGION
          region of the search template
static int SEARCH_TEMPLATE_REGION_VERTICAL
          region of the search template in vertical mode
 
Fields inherited from class com.wewebu.ow.server.app.OwSubLayout
DND_REGION, HOT_KEY_REGION, m_Configuration, m_isDynamicSplitInUse, m_MainContext, m_saveSplitPosition, m_settings, MAIN_REGION, MENU_REGION, NAVIGATION_REGION
 
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
OwRecordSubLayout()
           
 
Method Summary
 int getNavigationPanelInitialWidth()
          Get the initial width of the navigation panel, or the value configured in the attribute bags for this width.
In case that element has false value, the call of this method doesn't make sense, and -1 is returned.
 int getPreviewPropPanelInitialHeight()
          Get the initial height of the preview properties panel, or the value configured in the attribute bags for this height
 String getTreeClientSideId()
          Get the client side id for the tree component.
 boolean isRegion(int iRegion_p)
          determine if region exists
 void onAjaxNavigationPanelResize(javax.servlet.http.HttpServletRequest request_p, javax.servlet.http.HttpServletResponse response_p)
          AJAX handler invoked when the user resize the navigation panel.
 void onAjaxUpdateHotkeyRegion(javax.servlet.http.HttpServletRequest request_p, javax.servlet.http.HttpServletResponse response_p)
          Handler for the AJAX_UPDATE_HOTKEY_REGION.
 void onAjaxUpdateMenuRegion(javax.servlet.http.HttpServletRequest request_p, javax.servlet.http.HttpServletResponse response_p)
          Handler for the AJAX_UPDATE_MENU_REGION.
 void onAjaxUpdateSearchTemplatesRegion(javax.servlet.http.HttpServletRequest request_p, javax.servlet.http.HttpServletResponse response_p)
          Handler for the AJAX_UPDATE_SEARCH_TEMPLATES_REGION.
 void onAjaxUpdateSubLayoutMenu(javax.servlet.http.HttpServletRequest request_p, javax.servlet.http.HttpServletResponse response_p)
          AJAX handler for update the "UpdateSubLayoutMenu"
protected  void onRender(Writer w_p)
          render the view
 void renderRegion(Writer w_p, int iRegion_p)
          render the views of the region
 
Methods inherited from class com.wewebu.ow.server.app.OwSubLayout
createLayoutSettings, getBagID, getLayoutSettings, getNavigationPanelWidth, init
 
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, getTitle, getViewList, 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

OW_SUB_LAYOUT_MENU_DIV_ID

public static final String OW_SUB_LAYOUT_MENU_DIV_ID
The sub layout menu div id.

Since:
3.1.0.0
See Also:
Constant Field Values

OW_REGION_DND_APPLET_DIV_ID

public static final String OW_REGION_DND_APPLET_DIV_ID
See Also:
Constant Field Values

OW_REGION_MENU_DIV_ID

public static final String OW_REGION_MENU_DIV_ID
See Also:
Constant Field Values

OW_REGION_HOTKEY_DIV_ID

public static final String OW_REGION_HOTKEY_DIV_ID
See Also:
Constant Field Values

OW_REGION_SEARCHTEMPLATE_DIV_ID

public static final String OW_REGION_SEARCHTEMPLATE_DIV_ID
See Also:
Constant Field Values

AJAX_UPDATE_SUB_LAYOUT_MENU

public static final String AJAX_UPDATE_SUB_LAYOUT_MENU
The event name for update the OW_SUB_LAYOUT_MENU_DIV_ID div.

Since:
3.1.0.0
See Also:
Constant Field Values

AJAX_UPDATE_DND_APPLET_REGION

public static final String AJAX_UPDATE_DND_APPLET_REGION
See Also:
Constant Field Values

AJAX_UPDATE_MENU_REGION

public static final String AJAX_UPDATE_MENU_REGION
See Also:
Constant Field Values

AJAX_UPDATE_HOTKEY_REGION

public static final String AJAX_UPDATE_HOTKEY_REGION
See Also:
Constant Field Values

AJAX_UPDATE_SEARCH_TEMPLATES_REGION

public static final String AJAX_UPDATE_SEARCH_TEMPLATES_REGION
See Also:
Constant Field Values

JSP_FORM_ELEMENT_NAME

protected static final String JSP_FORM_ELEMENT_NAME
the name of the element containing the path to the JSP used for rendering

Since:
3.1.0.0
See Also:
Constant Field Values

DEFAULT_JSP_FORM

protected static final String DEFAULT_JSP_FORM
path to the default JSP form, to be used for rendering.

Since:
3.1.0.0
See Also:
Constant Field Values

SEARCH_TEMPLATE_REGION

public static final int SEARCH_TEMPLATE_REGION
region of the search template

See Also:
Constant Field Values

PREVIEW_PROPERTY_REGION

public static final int PREVIEW_PROPERTY_REGION
region of the property preview

See Also:
Constant Field Values

NAVIGATION_REGION_REGISTER_MODE

public static final int NAVIGATION_REGION_REGISTER_MODE
region of the the treeview in register optional mode

See Also:
Constant Field Values

SEARCH_TEMPLATE_REGION_VERTICAL

public static final int SEARCH_TEMPLATE_REGION_VERTICAL
region of the search template in vertical mode

See Also:
Constant Field Values
Constructor Detail

OwRecordSubLayout

public OwRecordSubLayout()
Method Detail

renderRegion

public void renderRegion(Writer w_p,
                         int iRegion_p)
                  throws Exception
render the views of the region

Specified by:
renderRegion in interface com.wewebu.ow.server.ui.OwBaseView
Overrides:
renderRegion in class com.wewebu.ow.server.ui.OwLayout
Parameters:
w_p - Writer object to write HTML to
iRegion_p - ID of the region to render
Throws:
Exception

isRegion

public boolean isRegion(int iRegion_p)
determine if region exists

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

onRender

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

Overrides:
onRender in class com.wewebu.ow.server.app.OwSubLayout
Parameters:
w_p - Writer object to write HTML to
Throws:
Exception

getTreeClientSideId

public String getTreeClientSideId()
Get the client side id for the tree component.

Returns:
- the client side id for the tree component.
Since:
3.1.0.0

getNavigationPanelInitialWidth

public int getNavigationPanelInitialWidth()
Get the initial width of the navigation panel, or the value configured in the attribute bags for this width.
In case that element has false value, the call of this method doesn't make sense, and -1 is returned.

Returns:
- the navigation panel width.
Since:
3.1.0.0

getPreviewPropPanelInitialHeight

public int getPreviewPropPanelInitialHeight()
Get the initial height of the preview properties panel, or the value configured in the attribute bags for this height

Returns:
- the initial height of the tree panel, or the value configured in the attribute bags for this height In case that element has false value, the call of this method doesn't make sense, and -1 is returned.
Since:
3.1.0.0

onAjaxNavigationPanelResize

public void onAjaxNavigationPanelResize(javax.servlet.http.HttpServletRequest request_p,
                                        javax.servlet.http.HttpServletResponse response_p)
AJAX handler invoked when the user resize the navigation panel.

Overrides:
onAjaxNavigationPanelResize in class com.wewebu.ow.server.app.OwSubLayout
Parameters:
request_p - - the HttpServletRequest object.
response_p - - the HttpServletResponse object
Since:
3.1.0.0

onAjaxUpdateSubLayoutMenu

public void onAjaxUpdateSubLayoutMenu(javax.servlet.http.HttpServletRequest request_p,
                                      javax.servlet.http.HttpServletResponse response_p)
                               throws Exception
AJAX handler for update the "UpdateSubLayoutMenu"

Parameters:
request_p -
response_p -
Throws:
Exception

onAjaxUpdateMenuRegion

public void onAjaxUpdateMenuRegion(javax.servlet.http.HttpServletRequest request_p,
                                   javax.servlet.http.HttpServletResponse response_p)
                            throws Exception
Handler for the AJAX_UPDATE_MENU_REGION.

Parameters:
request_p -
response_p -
Throws:
Exception

onAjaxUpdateHotkeyRegion

public void onAjaxUpdateHotkeyRegion(javax.servlet.http.HttpServletRequest request_p,
                                     javax.servlet.http.HttpServletResponse response_p)
                              throws Exception
Handler for the AJAX_UPDATE_HOTKEY_REGION.

Parameters:
request_p -
response_p -
Throws:
Exception

onAjaxUpdateSearchTemplatesRegion

public void onAjaxUpdateSearchTemplatesRegion(javax.servlet.http.HttpServletRequest request_p,
                                              javax.servlet.http.HttpServletResponse response_p)
                                       throws Exception
Handler for the AJAX_UPDATE_SEARCH_TEMPLATES_REGION.

Parameters:
request_p -
response_p -
Throws:
Exception


Copyright © 2013 Alfresco Business Solutions. All Rights Reserved.