com.wewebu.ow.server.plug.owdoccopy

Class OwRecordFunctionPaste

java.lang.Object

com.wewebu.ow.server.app.OwFunction

com.wewebu.ow.server.app.OwRecordFunction

com.wewebu.ow.server.plug.owdoccopy.OwRecordFunctionPaste

All Implemented Interfaces:

com.wewebu.ow.server.app.OwPlugin

public class OwRecordFunctionPaste
extends com.wewebu.ow.server.app.OwRecordFunction

Move Record Function to move items from the clipboard.

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
static int	INSERT_MODE_PHYSICALCOPY insert mode physical copy
static int	INSERT_MODE_REFERENCE insert mode reference

Fields inherited from class com.wewebu.ow.server.app.OwFunction

DESCRIPTION_KEY_CLASSES, DESCRIPTION_KEY_OBJ_TYPES, DESCRIPTION_KEY_TYPE, DRAG_DROP_PROPERTY_MAX_FILESIZE, m_MainContext

Constructor Summary

Constructors

Constructor and Description
OwRecordFunctionPaste()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	createPropertyMap() (overridable) Verification if property map need to be created for current processing. By default will return true, if current mode is set to INSERT_MODE_PHYSICALCOPY.
String	getBigIcon() get the URL to the info icon
String	getIcon() get the URL to the info icon
void	init(com.wewebu.ow.server.util.OwXMLUtil node_p, com.wewebu.ow.server.app.OwMainAppContext context_p) set the plugin description node
boolean	isEnabled(com.wewebu.ow.server.ecm.OwObject rootObject_p, com.wewebu.ow.server.ecm.OwObject folderObject_p, int iContext_p) check if function is enabled for the given object parameters
protected com.wewebu.ow.server.ecm.OwPropertyCollection	mapPropertyCollection(Map propertyMap_p, com.wewebu.ow.server.ecm.OwObject folderObject_p, com.wewebu.ow.server.ecm.OwObject sourceObject_p) Applies the given mapping rules on the folderObject-sourceObjet pair.
void	onClickEvent(com.wewebu.ow.server.ecm.OwObject rootObject_p, com.wewebu.ow.server.ecm.OwObject folderObject_p, com.wewebu.ow.server.app.OwClientRefreshContext refreshCtx_p) event called when user clicked the plugin label / icon
protected void	processCopyInstance(com.wewebu.ow.server.app.OwClipboardContentOwObject clipboardObject_p, com.wewebu.ow.server.ecm.OwObject folderObject_p, Map propertyMap_p) Overridable physical copy paste processing method.
protected void	processCopyRef(com.wewebu.ow.server.app.OwClipboardContentOwObject clipboardObject_p, com.wewebu.ow.server.ecm.OwObject folderObject_p, Map propertyMap_p) Overridable reference paste processing method.
protected void	processCut(com.wewebu.ow.server.app.OwClipboardContentOwObject clipboardObject_p, com.wewebu.ow.server.ecm.OwObject folderObject_p, Map propertyMap_p) Overridable cut-triggered paste processing method.

Methods inherited from class com.wewebu.ow.server.app.OwRecordFunction

addHistoryEvent, addHistoryEvent, getBigDefaultIconHTML, getBigIconHTML, getDefaultIconHTML, getDefaultLabel, getDragDropProperties, getIconHTML, getLabel, getPluginType, isDragDropTarget, isMultifileDragDropAllowed, onClickEvent

Methods inherited from class com.wewebu.ow.server.app.OwFunction

getConfigNode, getContext, getContextMenu, getEventManager, getHelpPath, getName, getNoEvent, getPluginID, getPluginTitle, getPluginTypeDisplayName, getSafeSetting, getSupportedObjectClassesFromDescriptor, getSupportedObjectTypesFromDescriptor, getTooltip, isObjectClassSupported, setSafeSetting

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INSERT_MODE_REFERENCE

public static final int INSERT_MODE_REFERENCE

insert mode reference

See Also:

Constant Field Values

INSERT_MODE_PHYSICALCOPY

public static final int INSERT_MODE_PHYSICALCOPY

insert mode physical copy

See Also:

Constant Field Values

Constructor Detail

OwRecordFunctionPaste

public OwRecordFunctionPaste()

Method Detail

init

public void init(com.wewebu.ow.server.util.OwXMLUtil node_p,
        com.wewebu.ow.server.app.OwMainAppContext context_p)
          throws Exception

set the plugin description node

Overrides:

init in class com.wewebu.ow.server.app.OwRecordFunction

Parameters:

node_p - OwXMLUtil wrapped DOM Node containing the plugin description

context_p - OwMainAppContext

Throws:

Exception

getIcon

public String getIcon()
               throws Exception

get the URL to the info icon

Specified by:

getIcon in interface com.wewebu.ow.server.app.OwPlugin

Overrides:

getIcon in class com.wewebu.ow.server.app.OwFunction

Returns:

String URL

Throws:

Exception

getBigIcon

public String getBigIcon()
                  throws Exception

get the URL to the info icon

Overrides:

getBigIcon in class com.wewebu.ow.server.app.OwFunction

Returns:

String URL

Throws:

Exception

isEnabled

public boolean isEnabled(com.wewebu.ow.server.ecm.OwObject rootObject_p,
                com.wewebu.ow.server.ecm.OwObject folderObject_p,
                int iContext_p)
                  throws Exception

check if function is enabled for the given object parameters

Overrides:

isEnabled in class com.wewebu.ow.server.app.OwRecordFunction

Parameters:

rootObject_p - OwObject root folder to work on

folderObject_p - OwObject selected folder to work on

Returns:

true = enabled, false otherwise

Throws:

Exception

processCut

protected void processCut(com.wewebu.ow.server.app.OwClipboardContentOwObject clipboardObject_p,
              com.wewebu.ow.server.ecm.OwObject folderObject_p,
              Map propertyMap_p)
                   throws Exception

Overridable cut-triggered paste processing method.

Parameters:

clipboardObject_p - cutted clipboard object to be pasted

folderObject_p - paste destination folder

propertyMap_p - the configured property map rules (can be null)

Throws:

Exception

Since:

3.2.0.1

processCopyRef

protected void processCopyRef(com.wewebu.ow.server.app.OwClipboardContentOwObject clipboardObject_p,
                  com.wewebu.ow.server.ecm.OwObject folderObject_p,
                  Map propertyMap_p)
                       throws Exception

Overridable reference paste processing method. Called on INSERT_MODE_REFERENCE configured plugin instances.

Parameters:

clipboardObject_p - copied clipboard object to be pasted

folderObject_p - paste destination folder

propertyMap_p - the configured property map rules (can be null)

Throws:

Exception

Since:

3.2.0.1

processCopyInstance

protected void processCopyInstance(com.wewebu.ow.server.app.OwClipboardContentOwObject clipboardObject_p,
                       com.wewebu.ow.server.ecm.OwObject folderObject_p,
                       Map propertyMap_p)
                            throws Exception

Overridable physical copy paste processing method. Called on INSERT_MODE_PHYSICALCOPY configured plugin instances.

Parameters:

clipboardObject_p - copied clipboard object to be pasted

folderObject_p - paste destination folder

propertyMap_p - the configured property map rules (can be null)

Throws:

Exception

Since:

3.2.0.1

mapPropertyCollection

protected com.wewebu.ow.server.ecm.OwPropertyCollection mapPropertyCollection(Map propertyMap_p,
                                                                  com.wewebu.ow.server.ecm.OwObject folderObject_p,
                                                                  com.wewebu.ow.server.ecm.OwObject sourceObject_p)
                                                                       throws Exception

Applies the given mapping rules on the folderObject-sourceObjet pair. See bootstrap documentation on defining property mappings.

Parameters:

propertyMap_p - property mappings rule map (can be null)

folderObject_p -

sourceObject_p -

Returns:

an OwPropertyCollection containing properties defined by the given mapping with values set according to the mapping expressions (see bootstrap documentation on property mappings).

Throws:

Exception

Since:

3.2.0.1

onClickEvent

public void onClickEvent(com.wewebu.ow.server.ecm.OwObject rootObject_p,
                com.wewebu.ow.server.ecm.OwObject folderObject_p,
                com.wewebu.ow.server.app.OwClientRefreshContext refreshCtx_p)
                  throws Exception

event called when user clicked the plugin label / icon

Overrides:

onClickEvent in class com.wewebu.ow.server.app.OwRecordFunction

Parameters:

rootObject_p - OwObject root folder to work on

folderObject_p - OwObject selected folder to work on

refreshCtx_p - OwFunctionRefreshContext callback interface for the function plugins to signal refresh events to clients, can be null if no refresh is needed

Throws:

Exception

createPropertyMap

protected boolean createPropertyMap()

(overridable) Verification if property map need to be created for current processing.
By default will return true, if current mode is set to INSERT_MODE_PHYSICALCOPY.

Returns:

boolean

Since:

3.2.0.1