com.wewebu.ow.server.plug.owdoccopy

Class OwDocumentFunctionAddToClipboard

java.lang.Object

com.wewebu.ow.server.app.OwFunction

com.wewebu.ow.server.app.OwDocumentFunction

com.wewebu.ow.server.plug.owdoccopy.OwDocumentFunctionAddToClipboard

All Implemented Interfaces:

com.wewebu.ow.server.app.OwPlugin

Direct Known Subclasses:

OwDocumentFunctionCopy, OwDocumentFunctionCut

public abstract class OwDocumentFunctionAddToClipboard
extends com.wewebu.ow.server.app.OwDocumentFunction

Implementation of common behavior for Cut and Copy document functions.

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

Since:

3.0.0.0

Field Summary

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
OwDocumentFunctionAddToClipboard()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract OwCommandAddToClipboard	createAddToClipboardCommand(com.wewebu.ow.server.ecm.OwObject oParent_p, List objects_p) Create the concrete OwCommandAddToClipboard object.
protected void	executeAddToClipboadCommand(com.wewebu.ow.server.ecm.OwObject oParent_p, List objects_p) Executes the addToClipboard command
void	onClickEvent(com.wewebu.ow.server.ecm.OwObject oObject_p, com.wewebu.ow.server.ecm.OwObject oParent_p, com.wewebu.ow.server.app.OwClientRefreshContext refreshCtx_p) event called when user clicked the plugin label / icon
protected abstract void	onClickEventPostProcessing(com.wewebu.ow.server.ecm.OwObject oObject_p, com.wewebu.ow.server.ecm.OwObject oParent_p) This method is called after the click event was processed.
void	onMultiselectClickEvent(Collection objects_p, com.wewebu.ow.server.ecm.OwObject oParent_p, com.wewebu.ow.server.app.OwClientRefreshContext refreshCtx_p) event called when user clicked the plugin for multiple selected items

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

addHistoryEvent, addHistoryEvent, getBigDefaultIconHTML, getBigIconHTML, getColumnTitle, getContextMenu, getDefaultIconHTML, getDefaultLabel, getDisplayNameFromUserId, getEnableColumnClickEvent, getIconHTML, getLabel, getMultiselect, getNeedParent, getObjectInstance, getPluginType, getRetrievalPropertyNames, getShowInEditViews, init, isEnabled, isEnabled, isObjectTypeSupported, onColumnClickEvent

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

getBigIcon, getConfigNode, getContext, getDragDropProperties, getEventManager, getHelpPath, getIcon, getName, getNoEvent, getPluginID, getPluginTitle, getPluginTypeDisplayName, getSafeSetting, getSupportedObjectClassesFromDescriptor, getSupportedObjectTypesFromDescriptor, getTooltip, isDragDropTarget, isObjectClassSupported, setSafeSetting

Methods inherited from class java.lang.Object

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

Constructor Detail

OwDocumentFunctionAddToClipboard

public OwDocumentFunctionAddToClipboard()

Method Detail

createAddToClipboardCommand

protected abstract OwCommandAddToClipboard createAddToClipboardCommand(com.wewebu.ow.server.ecm.OwObject oParent_p,
                                                  List objects_p)

Create the concrete OwCommandAddToClipboard object.

Parameters:

oParent_p - - the parent folder

objects_p - - the collection of objects

Returns:

- the OwCommandAddToClipboard object.

executeAddToClipboadCommand

protected void executeAddToClipboadCommand(com.wewebu.ow.server.ecm.OwObject oParent_p,
                               List objects_p)
                                    throws Exception

Executes the addToClipboard command

Parameters:

oParent_p -

objects_p -

Throws:

Exception

Since:

3.0.0.0

onMultiselectClickEvent

public void onMultiselectClickEvent(Collection objects_p,
                           com.wewebu.ow.server.ecm.OwObject oParent_p,
                           com.wewebu.ow.server.app.OwClientRefreshContext refreshCtx_p)
                             throws Exception

event called when user clicked the plugin for multiple selected items

Overrides:

onMultiselectClickEvent in class com.wewebu.ow.server.app.OwDocumentFunction

Parameters:

objects_p - Collection of OwObject

oParent_p - Parent which listed the Objects

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

Throws:

Exception

onClickEventPostProcessing

protected abstract void onClickEventPostProcessing(com.wewebu.ow.server.ecm.OwObject oObject_p,
                              com.wewebu.ow.server.ecm.OwObject oParent_p)
                                            throws Exception,
                                                   com.wewebu.ow.server.exceptions.OwInvalidOperationException

This method is called after the click event was processed.

Parameters:

oObject_p -

oParent_p -

Throws:

Exception

com.wewebu.ow.server.exceptions.OwInvalidOperationException

onClickEvent

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

event called when user clicked the plugin label / icon

Specified by:

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

Parameters:

oObject_p - OwObject where event was triggered

oParent_p - Parent which listed the Object

Throws:

Exception