public class OwMainLayout extends OwLayout implements OwDialog.OwDialogListener
Main Layout for Workdesk. Instance stays active during session.
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
OwLayout.OwDispatchRegion, OwLayout.OwLayoutViewRefrence
Modifier and Type | Field and Description |
---|---|
static int |
CLIPBOARD_REGION
name of the maximized region.
|
static int |
CURRENT_DATE_REGION
name of the date region.
|
static int |
DIALOG_REGION
name of the dialog region.
|
static String |
ERROR_CONTAINER_ID
the HTML error container ID
|
static int |
ERROR_REGION
name of the login info region.
|
static String |
KEY_INFO_CONTAINER_ID
the HTML key info container ID
|
static int |
KEYBOARD_REGION
name of the region that describes the registered keyboard keys
|
static int |
LOGOUT_BUTTON_REGION
name of the logout button region.
|
static String |
LOGOUT_DISABLED |
static String |
LOGOUT_STATUS |
protected OwConfiguration |
m_Configuration
application m_Configuration reference
|
protected OwMainAppContext |
m_MainContext
reference to the cast AppContext
|
protected OwView |
m_MaximizedView
currently maximized view if set
|
static int |
MAIN_REGION
name of the main region shared with DIALOG_REGION
|
static int |
MANDATOR_REGION
name of the mandator region.
|
static int |
MAXIMIZED_REGION
name of the maximized region.
|
static String |
MESSAGE_CONTAINER_ID
the HTML message container ID
|
static int |
MESSAGE_REGION
name of the login info region.
|
static int |
NAVIGATION_REGION
name of the navigation region
|
static int |
PROFILE_ACTION_REGION |
static String |
REGISTERED_KEYS_SCRIPTS_CONTAINER_ID
the registerd scripts container ID
|
static int |
ROLE_SELECT_REGION
name of the region that displays the available roles
|
static int |
USERNAME_REGION
name of the user name region.
|
CURRENT_MODULE_KEY, FORMULAR_PLACEHOLDER_END_DELIMITER, FORMULAR_PLACEHOLDER_START_DELIMITER, m_externalFormEventTarget
EMPTY_STRING
Constructor and Description |
---|
OwMainLayout() |
Modifier and Type | Method and Description |
---|---|
protected OwMainNavigationView |
createMainNavigationView()
(overridable)
Factory for OwMainNavigationView
|
protected OwProfileDialog |
createUserProfileView()
(overridable)
Factory for OwProfileDialog used in
onShowProfile(HttpServletRequest) |
String |
getBreadcrumbPart()
This method is used to create a "Breadcrumb"
navigation view.
|
protected OwView |
getMaximizeView()
overridable function to retrieve the view that is shown maximized if any
|
String |
getTitle()
overridable title of the view
|
boolean |
hasError()
Check if the context has an error set.
|
boolean |
hasMessages()
Check if the context has messages set.
|
protected void |
init()
init the view after the context is set.
|
boolean |
isRegion(int iRegion_p)
determine if region contains a view or must be rendered
|
void |
onAjaxUpdate(javax.servlet.http.HttpServletRequest request_p,
javax.servlet.http.HttpServletResponse response_p)
AJAX handler for update the error message.
|
void |
onDialogClose(OwDialog dialogView_p)
called if the Dialog that was opened by this view closes
|
void |
onLogOut(javax.servlet.http.HttpServletRequest request_p)
event called when user clicked LogOut
|
protected void |
onRender(Writer w_p)
render the view
|
void |
onSelectRole(javax.servlet.http.HttpServletRequest request_p)
called when user selects a role in the combobox
|
void |
onShowProfile(javax.servlet.http.HttpServletRequest req)
Open a Dialog which will display the current User Profile.
|
void |
renderRegion(Writer w_p,
int iRegion_p)
render the views of the region
|
protected void |
setMaximizeView(OwView view_p)
overridable function to set a view as a maximized view, i.e.
|
addRegion, addView, addView, addViewReference, getIterator, getViewRegion, isRegionMaximized, isRegionMinimized, isRegionNormal, renderNamedRegion
activate, detach, getDocument, getExternalFormEventTarget, getFormName, getFormTarget, getIcon, getParent, getRenderedNamedRegion, getRenderedRegion, getViewList, isFormTargetExternal, isNamedRegion, isShowMaximized, isShowMinimized, isShowNormal, onActivate, onUpdate, render, renderHTMLFormular, serverSideDesignInclude, serverSideInclude, setDocument, setExternalFormTarget, setParent, showMaximized, showMinimized, showNormal, usesFormWithAttributes
attach, disableRequestListener, enableRequestListener, getAjaxEventURL, getContext, getEventURL, getFormEventFunction, getFormEventURL, getID, onExternalRequest, onFormEvent, onRequest, updateExternalFormTarget
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
onUpdate
public static final int NAVIGATION_REGION
public static final int MAIN_REGION
public static final int DIALOG_REGION
public static final int ERROR_REGION
public static final int MAXIMIZED_REGION
public static final int CLIPBOARD_REGION
public static final int KEYBOARD_REGION
public static final int ROLE_SELECT_REGION
public static final int LOGOUT_BUTTON_REGION
public static final int USERNAME_REGION
public static final int CURRENT_DATE_REGION
public static final int MESSAGE_REGION
public static final int MANDATOR_REGION
public static final int PROFILE_ACTION_REGION
public static final String ERROR_CONTAINER_ID
public static final String MESSAGE_CONTAINER_ID
public static final String KEY_INFO_CONTAINER_ID
public static final String REGISTERED_KEYS_SCRIPTS_CONTAINER_ID
public static final String LOGOUT_STATUS
public static final String LOGOUT_DISABLED
protected OwConfiguration m_Configuration
protected OwMainAppContext m_MainContext
protected OwView m_MaximizedView
protected OwView getMaximizeView()
getMaximizeView
in class OwView
protected void init() throws Exception
public boolean isRegion(int iRegion_p)
isRegion
in interface OwBaseView
isRegion
in class OwLayout
iRegion_p
- ID of the regionpublic void onLogOut(javax.servlet.http.HttpServletRequest request_p) throws Exception
request_p
- HttpServletRequestException
public void onSelectRole(javax.servlet.http.HttpServletRequest request_p) throws Exception
Exception
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
protected void setMaximizeView(OwView view_p)
setMaximizeView
in class OwView
view_p
- OwView that requests to be shown maximizedpublic String getTitle()
OwView
getTitle
in interface OwBaseView
getTitle
in class OwView
public String getBreadcrumbPart()
OwBaseView
Example: We have a View A which contains a View B which
has a many views contained.
A.getBreadcrumbPart()
{
return this.getTitle() + " - " + B.getBreadcrumbPart();
}
B.getBreadcrumbPart()
{
return this.getName() + " - " + getMainView().getBreadcrumbPart();
}
null
at
least the OwBaseView.EMPTY_STRING
should be returned.getBreadcrumbPart
in interface OwBaseView
getBreadcrumbPart
in class OwView
public void onAjaxUpdate(javax.servlet.http.HttpServletRequest request_p, javax.servlet.http.HttpServletResponse response_p) throws Exception
request_p
- - the HttpServletRequest
request object.response_p
- - the HttpServletResponse
response object.Exception
public boolean hasError()
public boolean hasMessages()
protected OwMainNavigationView createMainNavigationView()
protected OwProfileDialog createUserProfileView()
onShowProfile(HttpServletRequest)
public void onShowProfile(javax.servlet.http.HttpServletRequest req) throws Exception
req
- HttpServletRequestException
public void onDialogClose(OwDialog dialogView_p) throws Exception
OwDialog.OwDialogListener
onDialogClose
in interface OwDialog.OwDialogListener
dialogView_p
- the Dialog that closed.Exception
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.