public class OwMasterDocument extends OwDocument
Document Module base class for the Main Area Plugins.
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
m_ViewList
Constructor and Description |
---|
OwMasterDocument() |
Modifier and Type | Method and Description |
---|---|
Object |
dispatch(int iCode_p,
Object param1_p,
Object param2_p)
dispatch an event to the master plugin by calling onDispatch in the master document
|
OwXMLUtil |
getConfigNode()
get the plugin description node
|
OwConfiguration |
getConfiguration()
get the configuration object
|
OwMasterView |
getMasterView()
get the corresponding masterview
|
OwAttributeBagWriteable |
getPersistentAttributeBagWriteable()
get the plugin scalar settings specific for the current user.
|
OwConfiguration.OwMasterPluginInstance |
getPlugin()
set the plugin instance
|
String |
getPluginID()
get the plugin ID
|
Object |
getSafeSetting(String strName_p,
Object default_p)
get a settings value for the plugin
|
protected void |
init()
init the target after the context is set.
|
protected Object |
onDispatch(int iCode_p,
Object param1_p,
Object param2_p)
This function can be overloaded to dispatch generic calls from other plugins
this is a generic function, used for communication of plugins,
which do not know about the interfaces of each other.
|
void |
setPlugin(OwConfiguration.OwMasterPluginInstance plugin_p)
set the plugin instance
|
void |
setSafeSetting(String strName_p,
Object value_p)
set a settings value for the plugin
NOTE: You must call OwMainAppContext.saveUserPrefs(); to serialize the new value
This function serializes against the XML Preferences and takes a lot of runtime.
|
attachView, attributecount, clear, detachView, getAttribute, getAttribute, getAttributeNames, getSafeAttribute, hasAttribute, remove, save, setAttribute, update
attach, detach, disableRequestListener, enableRequestListener, getAjaxEventURL, getContext, getEventURL, getFormEventFunction, getFormEventURL, getFormName, getFormTarget, getID, onExternalRequest, onFormEvent, onRequest, setExternalFormTarget, updateExternalFormTarget
protected void init() throws Exception
init
in class OwDocument
Exception
public void setPlugin(OwConfiguration.OwMasterPluginInstance plugin_p)
plugin_p
- OwPluginpublic OwConfiguration.OwMasterPluginInstance getPlugin()
public String getPluginID()
public OwXMLUtil getConfigNode()
public OwConfiguration getConfiguration()
public Object getSafeSetting(String strName_p, Object default_p)
strName_p
- name of property to retrievedefault_p
- Object if setting is not defined in plugin descriptorpublic void setSafeSetting(String strName_p, Object value_p) throws Exception
strName_p
- name of property to retrievevalue_p
- Object to setException
public OwAttributeBagWriteable getPersistentAttributeBagWriteable() throws Exception
getPersistentAttributeBagWriteable
in class OwDocument
Exception
protected Object onDispatch(int iCode_p, Object param1_p, Object param2_p) throws Exception
iCode_p
- enumerator designating the requested actionparam1_p
- Placeholder for optional parameterparam2_p
- Placeholder for optional parameterException
public Object dispatch(int iCode_p, Object param1_p, Object param2_p) throws Exception
iCode_p
- enumerator designating the requested actionparam1_p
- Placeholder for optional parameterparam2_p
- Placeholder for optional parameterException
public OwMasterView getMasterView()
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.