com.wewebu.ow.server.plug.owrecord

Class OwRecordRecordFunctionView

java.lang.Object

com.wewebu.ow.server.ui.OwEventTarget

com.wewebu.ow.server.ui.OwView

com.wewebu.ow.server.plug.owrecord.OwRecordRecordFunctionView

All Implemented Interfaces:

com.wewebu.ow.server.app.OwClientRefreshContext, com.wewebu.ow.server.ui.OwBaseView, com.wewebu.ow.server.ui.OwUpdateTarget, EventListener

Direct Known Subclasses:

OwRecordRecordFunctionDnDView

public class OwRecordRecordFunctionView
extends com.wewebu.ow.server.ui.OwView
implements com.wewebu.ow.server.app.OwClientRefreshContext

View to display the record functions for the opened record.

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

Field Summary

Fields

Modifier and Type	Field and Description
protected List	m_DocumentFunctionPluginList list of Document function plugins which have been instantiated
protected List	m_recordFunctionPluginList list to the record function plugins
protected static String	QUERY_KEY_PLUGIN query string key for the plugin index
static String	UPDATE_AJAX_EVENT_NAME

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

Constructors

Constructor and Description
OwRecordRecordFunctionView()

Method Summary

Methods

Modifier and Type	Method and Description
com.wewebu.ow.server.ecm.OwObject	getCurrentRootFolder()
com.wewebu.ow.server.ecm.OwObject	getCurrentSubFolderObject()
com.wewebu.ow.server.ecm.OwObject	getCurrentSubFolderObjectParent()
String	getDocumentFunctionEventURL(int iPlugIndex_p) get the event URL for document plugin functions
com.wewebu.ow.server.ecm.OwObject	getDocumentFunctionWorkobject() get the folder object that the document functions should work on can be either root or selected folder
com.wewebu.ow.server.ecm.OwObject	getDocumentFunctionWorkobjectParent() get the parent folder of the current folder object that the document functions should work on can be null if no parent is available
List	getDocumentFuntionPlugins()
boolean	getIsPluginEnabled(com.wewebu.ow.server.app.OwDocumentFunction docFunctionPlugin_p) Check if the DocumentFunction is enabled
boolean	getIsPluginEnabled(com.wewebu.ow.server.app.OwRecordFunction recordFunctionPlugin_p) Check if the RecordFunctionPlugin is enabled
String	getRecordFunctionEventURL(int iPlugIndex_p) get the event URL for record plugin functions
List	getRecordFuntionPlugins()
void	init()
void	onAjaxUpdate(javax.servlet.http.HttpServletRequest request_p, javax.servlet.http.HttpServletResponse response_p) Handler for AJAX request to update the content.
void	onClientRefreshContextUpdate(int iReason_p, Object param_p) implementation of the OwFunction.OwFunctionRefreshContext interface Called from a plugin to inform its client and cause refresh of display data
void	onDocumentFunctionPluginEvent(javax.servlet.http.HttpServletRequest request_p) event called when user clicked a plugin link
void	onRecordFunctionPluginEvent(javax.servlet.http.HttpServletRequest request_p) event called when user clicked a plugin link
protected void	onRender(Writer w_p)
boolean	showDisabledRecordFunctions() flag indicating if disabled record functions should be displayed disabled

Methods inherited from class com.wewebu.ow.server.ui.OwView

activate, addView, detach, getBreadcrumbPart, getDocument, getExternalFormEventTarget, getFormName, getFormTarget, getIcon, getIterator, getMaximizeView, getParent, getRenderedNamedRegion, getRenderedRegion, getTitle, getViewList, isFormTargetExternal, isNamedRegion, isRegion, isShowMaximized, isShowMinimized, isShowNormal, onActivate, onUpdate, render, renderHTMLFormular, renderNamedRegion, renderRegion, 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

UPDATE_AJAX_EVENT_NAME

public static final String UPDATE_AJAX_EVENT_NAME

See Also:

Constant Field Values

QUERY_KEY_PLUGIN

protected static final String QUERY_KEY_PLUGIN

query string key for the plugin index

See Also:

Constant Field Values

m_recordFunctionPluginList

protected List m_recordFunctionPluginList

list to the record function plugins

m_DocumentFunctionPluginList

protected List m_DocumentFunctionPluginList

list of Document function plugins which have been instantiated

Constructor Detail

OwRecordRecordFunctionView

public OwRecordRecordFunctionView()

Method Detail

init

public void init()
          throws Exception

Overrides:

init in class com.wewebu.ow.server.ui.OwView

Throws:

Exception

showDisabledRecordFunctions

public boolean showDisabledRecordFunctions()

flag indicating if disabled record functions should be displayed disabled

Returns:

boolean true = display disabled record functions gray, false = do not display disabled record functions at all (save space)

getRecordFuntionPlugins

public List getRecordFuntionPlugins()

getDocumentFuntionPlugins

public List getDocumentFuntionPlugins()

getDocumentFunctionEventURL

public String getDocumentFunctionEventURL(int iPlugIndex_p)

get the event URL for document plugin functions

Parameters:

iPlugIndex_p -

Returns:

the URL for the document plugin functions as String

getRecordFunctionEventURL

public String getRecordFunctionEventURL(int iPlugIndex_p)

get the event URL for record plugin functions

Parameters:

iPlugIndex_p -

Returns:

the URL for the record plugin function as String

getIsPluginEnabled

public boolean getIsPluginEnabled(com.wewebu.ow.server.app.OwDocumentFunction docFunctionPlugin_p)
                           throws Exception

Check if the DocumentFunction is enabled

Parameters:

docFunctionPlugin_p - docFunctionPlugin_p to be checked

Returns:

boolean

Throws:

Exception

getIsPluginEnabled

public boolean getIsPluginEnabled(com.wewebu.ow.server.app.OwRecordFunction recordFunctionPlugin_p)
                           throws Exception

Check if the RecordFunctionPlugin is enabled

Parameters:

recordFunctionPlugin_p - RecordFunctionPlugin to be checked

Returns:

boolean

Throws:

Exception

getCurrentSubFolderObject

public com.wewebu.ow.server.ecm.OwObject getCurrentSubFolderObject()

getCurrentSubFolderObjectParent

public com.wewebu.ow.server.ecm.OwObject getCurrentSubFolderObjectParent()

getCurrentRootFolder

public com.wewebu.ow.server.ecm.OwObject getCurrentRootFolder()

onRender

protected void onRender(Writer w_p)
                 throws Exception

Overrides:

onRender in class com.wewebu.ow.server.ui.OwView

Parameters:

w_p - Writer

Throws:

Exception

getDocumentFunctionWorkobject

public com.wewebu.ow.server.ecm.OwObject getDocumentFunctionWorkobject()

get the folder object that the document functions should work on can be either root or selected folder

Returns:

OwObject

getDocumentFunctionWorkobjectParent

public com.wewebu.ow.server.ecm.OwObject getDocumentFunctionWorkobjectParent()

get the parent folder of the current folder object that the document functions should work on can be null if no parent is available

Returns:

OwObject

onDocumentFunctionPluginEvent

public void onDocumentFunctionPluginEvent(javax.servlet.http.HttpServletRequest request_p)
                                   throws Exception

event called when user clicked a plugin link

Parameters:

request_p - HttpServletRequest

Throws:

Exception

onRecordFunctionPluginEvent

public void onRecordFunctionPluginEvent(javax.servlet.http.HttpServletRequest request_p)
                                 throws Exception

event called when user clicked a plugin link

Parameters:

request_p - HttpServletRequest

Throws:

Exception

onClientRefreshContextUpdate

public void onClientRefreshContextUpdate(int iReason_p,
                                Object param_p)
                                  throws Exception

implementation of the OwFunction.OwFunctionRefreshContext interface Called from a plugin to inform its client and cause refresh of display data

Specified by:

onClientRefreshContextUpdate in interface com.wewebu.ow.server.app.OwClientRefreshContext

Parameters:

iReason_p - reason as defined with OwClientRefreshContext.REFRESH_...

param_p - Object optional parameter representing the refresh, depends on the value of iReason_p, can be null

Throws:

Exception

onAjaxUpdate

public void onAjaxUpdate(javax.servlet.http.HttpServletRequest request_p,
                javax.servlet.http.HttpServletResponse response_p)
                  throws Exception

Handler for AJAX request to update the content.

Parameters:

request_p - - the AJAX request object.

response_p - - the response

Throws:

Exception

Since:

3.1.0.0