com.wewebu.ow.server.plug.owshortcut

Class OwShortCutDocumentFunction

java.lang.Object

com.wewebu.ow.server.app.OwFunction

com.wewebu.ow.server.app.OwDocumentFunction

com.wewebu.ow.server.plug.owshortcut.OwShortCutDocumentFunction

All Implemented Interfaces:

com.wewebu.ow.server.app.OwPlugin

public class OwShortCutDocumentFunction
extends com.wewebu.ow.server.app.OwDocumentFunction

Short Cuts Function, creates a short cut in the OwShortCutDocument master plugin.

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

Method Summary

Methods

Modifier and Type	Method and Description
String	getBigIcon() get the URL to the info icon
com.wewebu.ow.server.app.OwMasterDocument	getFavoriteMasterPlugin() get the Bookmark/Favorite Master Plugin
String	getIcon() get the URL to the info icon
protected void	handleMissingShortCutSerializer(Collection<com.wewebu.ow.server.ecm.OwObject> objects) Method is called in case no favorite serializer is available.
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 object_p, com.wewebu.ow.server.ecm.OwObject parent_p, int context_p)
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
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, isEnabled, isObjectTypeSupported, onColumnClickEvent

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

getConfigNode, getContext, getDragDropProperties, getEventManager, getHelpPath, 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

OwShortCutDocumentFunction

public OwShortCutDocumentFunction()

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.OwDocumentFunction

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

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

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

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

handleMissingShortCutSerializer

protected void handleMissingShortCutSerializer(Collection<com.wewebu.ow.server.ecm.OwObject> objects)
                                        throws Exception

Method is called in case no favorite serializer is available.

Parameters:

objects - Collection of OwObject's

Throws:

Exception

Since:

4.2.0.0

getFavoriteMasterPlugin

public com.wewebu.ow.server.app.OwMasterDocument getFavoriteMasterPlugin()
                                                                  throws com.wewebu.ow.server.exceptions.OwConfigurationException

get the Bookmark/Favorite Master Plugin

Returns:

the Bookmark/Favorite Master Plugin as OwMasterDocument

Throws:

com.wewebu.ow.server.exceptions.OwConfigurationException

isEnabled

public boolean isEnabled(com.wewebu.ow.server.ecm.OwObject object_p,
                com.wewebu.ow.server.ecm.OwObject parent_p,
                int context_p)
                  throws Exception

Overrides:

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

Throws:

Exception

See Also:

OwDocumentFunction.isEnabled(com.wewebu.ow.server.ecm.OwObject, com.wewebu.ow.server.ecm.OwObject, int)