public abstract class OwRecordFunction extends OwFunction
Base class for Record Function plugins, used in the record plugin only.
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
DESCRIPTION_KEY_CLASSES, DESCRIPTION_KEY_OBJ_TYPES, DESCRIPTION_KEY_TYPE, DRAG_DROP_PROPERTY_MAX_FILESIZE, m_MainContext
Constructor and Description |
---|
OwRecordFunction() |
Modifier and Type | Method and Description |
---|---|
void |
addHistoryEvent(OwObject rootObject_p,
Collection objects_p,
int iEventType_p,
int iStatus_p)
add the plugin invoke event to the history manager
|
protected void |
addHistoryEvent(OwObject rootObject_p,
OwObject folderObject_p,
int iEventType_p,
int iStatus_p)
add the plugin invoke event to the history manager
|
String |
getBigDefaultIconHTML()
get the HTML code for the big (24x24 pixels) icon for this plugin to be displayed in the object list.
|
String |
getBigIconHTML(OwObject rootObject_p,
OwObject folderObject_p)
get the HTML code for the small (24x24 pixels) icon for this plugin to be displayed in the object list.
|
String |
getDefaultIconHTML()
get the HTML code for the small (16 x16 pixels) icon for this plugin to be displayed in the object list.
|
String |
getDefaultLabel()
get the label for the plugin, used in menus
Used for context menus where no object information is available
|
Properties |
getDragDropProperties()
get the properties for drag and drop like allowed file size and file count or file type...
|
String |
getIconHTML(OwObject rootObject_p,
OwObject folderObject_p)
get the HTML code for the small (16x16 pixels) icon for this plugin to be displayed in the object list.
|
String |
getLabel(OwObject rootObject_p,
OwObject folderObject_p)
get the label for the plugin, used in menus
|
String |
getPluginType()
get the plugin type
|
void |
init(OwXMLUtil node_p,
OwMainAppContext context_p)
set the plugin description node
|
boolean |
isDragDropTarget()
check if plugin acts as a drag and drop target
|
boolean |
isEnabled(OwObject rootObject_p,
OwObject folderObject_p,
int iContext_p)
check if function is enabled for the given object parameters
|
boolean |
isMultifileDragDropAllowed()
check if plugin allows multiple files to be dropped on it
|
void |
onClickEvent(OwObject rootObject_p,
OwObject folderObject_p,
OwClientRefreshContext refreshCtx_p)
event called when user clicked the plugin label / icon
overridable
|
void |
onClickEvent(OwObject rootObject_p,
OwObject folderObject_p,
String subpath_p,
String subdisplaypath_p,
OwClientRefreshContext refreshCtx_p)
event called when user clicked the plugin label / icon
overridable
|
getBigIcon, getConfigNode, getContext, getContextMenu, getEventManager, getHelpPath, getIcon, getName, getNoEvent, getPluginID, getPluginTitle, getPluginTypeDisplayName, getSafeSetting, getSupportedObjectClassesFromDescriptor, getSupportedObjectTypesFromDescriptor, getTooltip, isObjectClassSupported, setSafeSetting
public void init(OwXMLUtil node_p, OwMainAppContext context_p) throws Exception
init
in class OwFunction
node_p
- OwXMLUtil wrapped DOM Node containing the plugin descriptioncontext_p
- OwMainAppContextException
public String getDefaultIconHTML() throws Exception
Exception
public String getBigDefaultIconHTML() throws Exception
Exception
public String getIconHTML(OwObject rootObject_p, OwObject folderObject_p) throws Exception
rootObject_p
- OwObject root folder to work onfolderObject_p
- OwObject selected folder to work onException
public String getBigIconHTML(OwObject rootObject_p, OwObject folderObject_p) throws Exception
rootObject_p
- OwObject root folder to work onfolderObject_p
- OwObject selected folder to work onException
public String getLabel(OwObject rootObject_p, OwObject folderObject_p) throws Exception
rootObject_p
- OwObject root folder to work onfolderObject_p
- OwObject selected folder to work onException
public String getDefaultLabel() throws Exception
Exception
public boolean isEnabled(OwObject rootObject_p, OwObject folderObject_p, int iContext_p) throws Exception
rootObject_p
- OwObject root folder to work onfolderObject_p
- OwObject selected folder to work oniContext_p
- OwStatusContextDefinitionsException
public boolean isDragDropTarget()
isDragDropTarget
in class OwFunction
public boolean isMultifileDragDropAllowed()
public Properties getDragDropProperties()
getDragDropProperties
in class OwFunction
public void onClickEvent(OwObject rootObject_p, OwObject folderObject_p, String subpath_p, String subdisplaypath_p, OwClientRefreshContext refreshCtx_p) throws Exception
rootObject_p
- OwObject root folder to work onfolderObject_p
- OwObject selected folder to work onsubpath_p
- String subpath of subfolder or null if root foldersubdisplaypath_p
- String subpath of subfolderrefreshCtx_p
- OwClientRefreshContext callback interface for the function plugins to signal refresh events to clients, can be null if no refresh is neededException
public void onClickEvent(OwObject rootObject_p, OwObject folderObject_p, OwClientRefreshContext refreshCtx_p) throws Exception
rootObject_p
- OwObject root folder to work onfolderObject_p
- OwObject selected folder to work onrefreshCtx_p
- OwClientRefreshContext callback interface for the function plugins to signal refresh events to clients, can be null if no refresh is neededException
public void addHistoryEvent(OwObject rootObject_p, Collection objects_p, int iEventType_p, int iStatus_p) throws Exception
rootObject_p
- OwObject root folder to work onobjects_p
- OwObject objects that have to be auditediEventType_p
- int one out of:
OwEventManger.HISTORY_EVENT_TYPE_PLUGIN_INVOKE_UI
OwEventManger.HISTORY_EVENT_TYPE_PLUGIN_INVOKE_VIEW
OwEventManger.HISTORY_EVENT_TYPE_PLUGIN_INVOKE_EDITiStatus_p
- int Status as defined in OwEventManger.HISTORY_STATUS_...Exception
protected void addHistoryEvent(OwObject rootObject_p, OwObject folderObject_p, int iEventType_p, int iStatus_p) throws Exception
rootObject_p
- OwObject root folder to work onfolderObject_p
- OwObject selected folder to work oniEventType_p
- int one out of:
OwEventManger.HISTORY_EVENT_TYPE_PLUGIN_INVOKE_UI
OwEventManger.HISTORY_EVENT_TYPE_PLUGIN_INVOKE_VIEW
OwEventManger.HISTORY_EVENT_TYPE_PLUGIN_INVOKE_EDITiStatus_p
- int Status as defined in OwEventManger.HISTORY_STATUS_...Exception
public String getPluginType()
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.